Javadoc problem

[Rhino <rh...@sympatico.ca>]

I need some guidance on how to prevent a specific warning message from a
Javadoc task in Ant 1.6.2.

One of the programs for which I am generating Javadocs contains the line:

import common.Utilities;

This line causes the following warning in my Ant build:

[javadoc]
E:\eclipse\3.0.1\eclipse\workspace\Resume\src\resume\misc\ResumeHTML.java:13
: package common does not exist

[javadoc] import common.Utilities;

The package common.Utilities *does* exist and the program compiles and runs
fine. I'd like to know how to change my javadoc task so that the warning
message does not get generated during the build. I'm only referencing a
single small method in a Utilities class in this program and I don't feel
the need to document it in my Javadocs.

If it is the only way to prevent the warning message, I'd be willing to let
javadoc document that method (getHexColor()); however, I'd like to avoid
documenting the whole Utilities class if possible because it's got dozens of
small methods in it and only one of those is ever used in my program. If it
is not possible to document only the method I'm using, I'd be willing to
document all of the methods in the Utilities class.

I feel sure that there is some way to tell javadoc not to worry about this
import statement but I can't find anything in the javadoc documentation that
tells me how to do this. I thought the 'excludepackagenames' parameter
looked like the best bet for eliminating the warning but it didn't work; I
got the same warning and output with and without it.

This is my complete Javadoc task, which works perfectly aside from this one
warning:

<target name="gendocs"

description="Generate the Javadocs for the applet and its supporting
classes.">

<delete includeEmptyDirs="true"

description="Delete contents of javadoc directory but not the directory
itself.">

<fileset dir="${resume.javadoc.dir}" includes="**/*"/>

</delete>


<javadoc destdir="${resume.javadoc.dir}"

author="true"

version="true"

use="true"

windowtitle="Resume API"

excludepackagenames="common.Utilities"

breakiterator="true"

overview="${resume.html.dir}\overview.html" doctitle="Resume Overview"

description="Generate Javadocs for the project">


<fileset dir="${resume.src}" defaultexcludes="yes">

<patternset refid="ps.resume"/>

</fileset>

<fileset dir="${resume.misc.src}" defaultexcludes="yes">

<patternset refid="ps.resume.misc"/>

</fileset>

<fileset dir="${palette.src}" defaultexcludes="yes">

<patternset refid="ps.palette"/>

</fileset>


<doctitle><![CDATA[<h1>R&eacute;sum&eacute;</h1>]]></doctitle>

<bottom><![CDATA[<i>Copyright &#169; 2005 Reinhardt Christiansen. All Rights
Reserved.</i>]]></bottom>

<group title="Palette Packages" packages="palette*"/>

<group title="Resume Packages" packages="resume*"/>

<link href="http://java.sun.com/j2se/1.4.2/docs/api"/>

</javadoc>

</target>


Rhino
---
rhino1 AT sympatico DOT ca
"There are two ways of constructing a software design. One way is to make it
so simple that there are obviously no deficiencies. And the other way is to
make it so complicated that there are no obvious deficiencies." - C.A.R.
Hoare


---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
For additional commands, e-mail: user-help@ant.apache.org

Re: Javadoc problem

[Antoine Levy-Lambert <an...@gmx.de>]

Hello Rhino,
I think javadoc has a classpath attribute.
You presumably need to put in the javadoc classpath the jar containing
this common.Utilities class (or the root directory containing the
corresponding classes). Normally the classpath you use to compile a module
is also OK to run javadoc.
Cheers,
Antoine

> I need some guidance on how to prevent a specific warning message from a
> Javadoc task in Ant 1.6.2.
> 
> One of the programs for which I am generating Javadocs contains the line:
> 
> import common.Utilities;
> 
> This line causes the following warning in my Ant build:
> 
> [javadoc]
>
E:\eclipse\3.0.1\eclipse\workspace\Resume\src\resume\misc\ResumeHTML.java:13
> : package common does not exist
> 
> [javadoc] import common.Utilities;
> 
> The package common.Utilities *does* exist and the program compiles and
> runs
> fine. I'd like to know how to change my javadoc task so that the warning
> message does not get generated during the build. I'm only referencing a
> single small method in a Utilities class in this program and I don't feel
> the need to document it in my Javadocs.
> 
> If it is the only way to prevent the warning message, I'd be willing to
> let
> javadoc document that method (getHexColor()); however, I'd like to avoid
> documenting the whole Utilities class if possible because it's got dozens
> of
> small methods in it and only one of those is ever used in my program. If
> it
> is not possible to document only the method I'm using, I'd be willing to
> document all of the methods in the Utilities class.
> 
> I feel sure that there is some way to tell javadoc not to worry about this
> import statement but I can't find anything in the javadoc documentation
> that
> tells me how to do this. I thought the 'excludepackagenames' parameter
> looked like the best bet for eliminating the warning but it didn't work; I
> got the same warning and output with and without it.
> 
> This is my complete Javadoc task, which works perfectly aside from this
> one
> warning:
> 
> <target name="gendocs"
> 
> description="Generate the Javadocs for the applet and its supporting
> classes.">
> 
> <delete includeEmptyDirs="true"
> 
> description="Delete contents of javadoc directory but not the directory
> itself.">
> 
> <fileset dir="${resume.javadoc.dir}" includes="**/*"/>
> 
> </delete>
> 
> 
> <javadoc destdir="${resume.javadoc.dir}"
> 
> author="true"
> 
> version="true"
> 
> use="true"
> 
> windowtitle="Resume API"
> 
> excludepackagenames="common.Utilities"
> 
> breakiterator="true"
> 
> overview="${resume.html.dir}\overview.html" doctitle="Resume Overview"
> 
> description="Generate Javadocs for the project">
> 
> 
> <fileset dir="${resume.src}" defaultexcludes="yes">
> 
> <patternset refid="ps.resume"/>
> 
> </fileset>
> 
> <fileset dir="${resume.misc.src}" defaultexcludes="yes">
> 
> <patternset refid="ps.resume.misc"/>
> 
> </fileset>
> 
> <fileset dir="${palette.src}" defaultexcludes="yes">
> 
> <patternset refid="ps.palette"/>
> 
> </fileset>
> 
> 
> <doctitle><![CDATA[<h1>R&eacute;sum&eacute;</h1>]]></doctitle>
> 
> <bottom><![CDATA[<i>Copyright &#169; 2005 Reinhardt Christiansen. All
> Rights
> Reserved.</i>]]></bottom>
> 
> <group title="Palette Packages" packages="palette*"/>
> 
> <group title="Resume Packages" packages="resume*"/>
> 
> <link href="http://java.sun.com/j2se/1.4.2/docs/api"/>
> 
> </javadoc>
> 
> </target>
> 
> 
> Rhino
> ---
> rhino1 AT sympatico DOT ca
> "There are two ways of constructing a software design. One way is to make
> it
> so simple that there are obviously no deficiencies. And the other way is
> to
> make it so complicated that there are no obvious deficiencies." - C.A.R.
> Hoare
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
> For additional commands, e-mail: user-help@ant.apache.org
> 

---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@ant.apache.org
For additional commands, e-mail: user-help@ant.apache.org