How to tell what files have NOT been Javadoc'd.

Javadoc does not have a way to print what files it doesn't document (that I can think of).

Are you using the -subpackages option, or passing in package names, or passing in source filenames?

Are you asking for it to list classes within the scope of what you passed in on the command line that it did not document, or classes outside the scope?

Inside the scope, it would have to list classes with more restricted access than requested, such as private classes. Were you thinking of other cases?

Outside the scope would require you specify the scope you're interested in.

-Doug

dhkramera at 2007-7-14 0:51:37 >

I guess I do have come answers to your questions. Since we use NetBeans IDE to compile and generate Javadocs, the whole project gets compiled in one whack. I assume there is some sort of makefile (?) that lists out all the programs or toplevel directoy names, and all the subdirectories are recursively passed on down when th eoperation takes place.

ilevya at 2007-7-14 0:51:37 >

Our NetBeans IDE guru found an Ant solution. But it leaves a lot to be desired. That's why I'm posting this in the Forum. His solution is as follows.

The build.xml file was added the following:

<target name="Build Javadoc Report - Files">

<property file="nbproject/project.properties"/>

<property file="nbproject/private/private.properties"/>

<echo message="Building Javadoc package information"></echo>

<delete dir="dist/JavadocReport"></delete>

<mkdir dir="dist/JavadocReport"></mkdir>

<javadoc doclet="com.sun.tools.doclets.doccheck.DocCheck" docletpath="doccheck.jar" maxmemory="256M" destdir="dist/JavadocReport">

<packageset dir="${src.dir}" includes="*/**"/>

</javadoc>

This generates some reports. But the information is broken down in a way that it's not easy for a number of developers to sift through. The toplevel report is very top level, and you can't see the whole tree sturcture of what is not Javadoc'd in one swoop.

So I'm sifting through the list that this Ant script generates, and figurin out what who wrote what file, and what files are related to the top level report. For instance, the report might tell me that file cxxi.apisupport.pythonsupport has 5 files without Javadocs. But I have to click on "cxxi.apisupport.pythonsupport" to find out what the 5 files are, as these are listed in a separate part of the report. I think this is as close as I will get, with the limited knowledge I have at the moment about Javadocs, scripts, python and all this stuff.

have a nice weekend!

ilevya at 2007-7-14 0:51:37 >