List all Classes WITHOUT Javadocs

Question

Is there any simple way to analyze source code to list the number of classes that don't have any javadocs?

As part of a technical debt exercise I want to list all these files and share the list out among the team to have the original authors write them.

Note: We are using gradle as build system

UPDATE... So empty javadocs get created by default but our devs havnt filled them in much. Id like to be able to see all classes that dont have any description in the doc at class level. I dont mind about methods too much.

Answer 1

An easy way would be to use Checkstyle.

Download the jar file and create a config XML file (javadoc_checks.xml) like this:

<module name="Checker">
    <module name="TreeWalker">
        <module name="JavadocType"/>
        <module name="JavadocMethod"/>
        <module name="JavadocVariable"/>
        <module name="JavadocStyle"/>
    </module>
</module>

Now run the following command (assuming everything is in the same directory and src contains your code):

java -jar checkstyle-6.9-all.jar -c javadoc_checks.xml src/

If, for example, you just want to check for missing javadocs for classes and interfaces, then you just need this in the config XML:

<module name="Checker">
    <module name="TreeWalker">
        <module name="JavadocType"/>
    </module>
</module>

And the output would be something like:

C:\src\com\example\Test.java:137: Javadoc comment missing.
C:\src\com\example\Test1.java:3: Javadoc comment missing.
C:\src\com\example\Test2.java:12: Javadoc comment missing.

There are a lot of options, you can see them in:

http://checkstyle.sourceforge.net/config_javadoc.html

http://checkstyle.sourceforge.net/cmdline.html