tool to find missing documentation in Java Project

I have a java project. I am supposed to find out all the classes, constructors, methods and attributes in each file which are not documentated. I tried doing manually, but its taking lot of time ( there are about 40 packages).
Is there any tool which can find missing documentation for each file in the project.
LVL 8
thomas908Asked:
Who is Participating?
 
Giant2Connect With a Mentor Commented:
You can use, I think, Doclet.
See here!
http://java.sun.com/j2se/javadoc/doccheck/index.html

Giant.
0
 
MogalManicCommented:
Look into jalopy (http://jalopy.sourceforge.net/).  It is a code formatter that autogenerates javadoc.  You can install it as a plugin for eclipse and format whole packages at a time.  Then do a global search for "DOCUMENT ME!".
0
 
thomas908Author Commented:
I need a plugin for JBuilder
0
Free Tool: Path Explorer

An intuitive utility to help find the CSS path to UI elements on a webpage. These paths are used frequently in a variety of front-end development and QA automation tasks.

One of a set of tools we're offering as a way of saying thank you for being a part of the community.

 
thomas908Author Commented:
I think is generates javadoc, but does it tell about the missing documentation. Say in any file i have not given any documentation for class, method abc() and xyz() and attribute a.
I need a tool which tells me this.
0
 
MogalManicCommented:
You can configure jalopy to comment even to the attribute level.  It will correct the method @param comments as well.   It won't generate the comments for you, you still have to understand the code and put meaningfull comments.  It will put in the

There is a JBuilder integration module as well.  I assume it works like the eclipse plug-in.
0
 
thomas908Author Commented:
i don't need to generate comments, I just need to a sort of report which will show where the comments are missing (in which file for which class, method, attribute, constructor). I dont need to generate comments.
0
 
Giant2Commented:
I believe you must create one your own.
Bye, Giant.
0
 
Giant2Commented:
download it, install it and type:
jvadoc -doclet <doclet-name>

I believe this is what you need.

Bye, Giant.
0
 
Giant2Commented:
javadoc -doclet <doclet-name>
0
 
Giant2Commented:
in particular:
put the jar file of doccheck in your jdk lib directory (I have c:\jdk1.4\ for the jdk)
type:

set classpath=%classpath%;c:\jdk1.4\lib\tools.jar;c:\jdk1.4\lib\doccheck.jar

javadoc -doclet com.sun.tools.doclets.doccheck.DocCheck yourJavaFilesOrDirectory

And then, enjoy!!

This produce all you want.
Bye, Giant.
0
 
grim_toasterConnect With a Mentor Commented:
I use JCSC to this kind of thing, it can be used for general coding standards issues as well, and can/should be integrated into the build process:

http://jcsc.sourceforge.net/

It is fully customisable (there are over 100 rules in the latest edition), and if you are only after the javadoc rules, then only include them.  I also believe that you can get a plugin for most IDE's for it.
0
 
sciuriwareCommented:
I think those suggestions are good.
Besides, I believe there is a JBuilder plugin for JRefactory (on the same website)
You can tell it to put dummy comments of various type in all places where it's needed.
Another approach is to download ECLIPSE 3.1 and tell it to complain about missing comments.
Then take up your sources, let ECLIPSE look at it and use Ctrl/1 where ever to add your comments,
then take your sources back to JBUILDER.
;JOOP!
0
 
Giant2Commented:
Thanks.
Happy to help you.
:)
0
Question has a verified solution.

Are you are experiencing a similar issue? Get a personalized answer when you ask a related question.

Have a better answer? Share it in a comment.

All Courses

From novice to tech pro — start learning today.