Trying to invoke javadoc tag within Ant problem.

[Unnsse Khan]

Hello there,

In my build.xml file, this is the code snippet for my <javadoc> target:

<target name = "javadoc" description = "Generates JavaDoc">
<echo message="Generating API Javadocs...."/>

<mkdir dir = "${docs.dir}/javadoc" />
<javadoc packagenames="com.prototype.util.*"
     destdir="${docs.dir}/javadoc"
     author="true" version="false" use="true"
     windowtitle="My Prototype API"
     doctitle="Prototype"
     bottom="Copyright © 2004 Unnsse Khan. All Rights Reserved.">
 <classpath>
<!-- Include all JAR files in my local library -->
<fileset dir="${lib.dir}">
          <include name="*.jar"/>
        </fileset>
<pathelement path="${build.dir}"/>
 </classpath>
 <sourcepath>
<pathelement path="${src.dir}"/>
 </sourcepath>
</javadoc>
</target> 

The property variables (such as ${src.dir}) are specified in a build.properties file that looks like this:

# build.properties
# Configuration file which works in conjunction with build.xml
 
# Generic build properties
build.dir=./classes
deploy.dir=./deploy
docs.dir=./docs
src.dir=./src
lib.dir=./lib
xml.dir=./xml 

This is the output when I run it from the command line:

F:\DevProjects\Java\J2EE Projects\Prototype>ant javadoc
Buildfile: build.xml
 
javadoc:
     [echo] Generating API Javadocs....
 
BUILD FAILED
F:\DevProjects\Java\J2EE Projects\Prototype\build.xml:85: No source files and no packages have been specified.
 
Total time: 0 seconds
F:\DevProjects\Java\J2EE Projects\Prototype> 

I didn't think it was so hard just to generate javadoc using Ant, apparently there something that I am doing wrong....

I would appreciate any suggestions....

Thanks again and Happy Holidays,

[Ilja Preuss]

Run the script with -verbose or -debug.

My first guess is that the specified source dir doesn't exist or is empty.

[Unnsse Khan]

The specified source directory does exist... That's how I can achieve creating an executable jar from the "deploy" ant target.

Under my {src.dir}, do I have to follow the packaging conventions that I place for package at the top of my src files? I didn't think that this was necessary...

This is what I am trying to convey...

if you have a file called, HelloWorld.java and inside it you have the code:

package org.untz;

Should the {src.dir} structure look like this:

src
|
---
org
|
---
|
untz
|
--
HelloWorld.java

I didn't think that I needed to do this, because when you compile it with the -d argument, doesn't it make the <org> and <untz> directories for me?

Yes, I don't understand what I am not getting correct with my JavaDoc tag...

Can anyone put this in their own sample code and see if they can get it working?

Thanks again!

Happy Holidays!

Peace to all!

[Ilja Preuss]

Yes, I'm sure that's what your source directory should look like. I don't understand why the -d option of the compiler should have anything to do with it, though, so I might be missing something.

[Unnsse Khan]

I didn't quite understand what you were trying to convey...

Do I need to put sub-directories under 'src' that follow my package's structure? What exactly am I doing wrong with this javadoc target?

Lots of thanks!

-Unnsse M. Khan

[Ilja Preuss]

Originally posted by Unnsse Khan:

Do I need to put sub-directories under 'src' that follow my package's structure?

Yes.

Does that solve your problem?

[Unnsse Khan]

Ilja,

I created the directory structure, in order, to have it correlate with the package scheme specified in the source files.

That I don't believe fixed the problem, what fixed the problem was including the <packageset> tag in the Ant target:

<packageset dir="src" defaultexcludes="yes">
    <include name="com/mycompany/util/**" />
    <include name="com/mycompany/db/**" />
</packageset> 

Also, I didn't have the <sourcepath> listed as an attribute for the <javadoc> tag, I had it nested in the <classpath>. Well, it works now!

Happy Holidays!

See you next year,