Yes, you can add a target to your build-project.xml file that looks
something like this (specifying appropropriate values for ${src.dir}, etc.):

    <target name="javadocs"
            description="--> generates the xxx documentation">
        <mkdir dir="${javadocs.destdir}"/>
        <javadoc
            sourcepath="${src.dir}"
            packagenames="com.planetcad.${project}.*"
            destdir="${javadocs.destdir}"
            author="true"
            private="true"
            version="true"
            use="true"
            windowtitle="${Name} ${version} API"
            doctitle="${Name} ${version} API"
            bottom="Copyright &amp;copy; ${year} PlanetCAD, Inc.. All Rights
Reserved."
        >
            <classpath refid="classpath"/>
        </javadoc>
    </target>

Note that the packagenames attribute uses a wildcard to recurse.

Hope this helps,

Kevin

-----Original Message-----
From: Gareth Coltman [mailto:[EMAIL PROTECTED]]
Sent: Wednesday, May 09, 2001 9:20 AM
To: [EMAIL PROTECTED]
Subject: Javadoc


Hi,

I would like to build javadoc for my entire application. I have used
Turbine's javadocs task to build the Turbine API, and wonder how easy it
would be to add such a task to every project's build XML.

I am quite new to javadoc, and am a bit confused by the fact you don't seem
to be able to specify a package root and have javadoc recurse into the
package. This seems like quite a sensible thing to me!

If anyone knows an easy way to build my projecs API, please let me know.

Gareth


---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to