wood burning stoves 2.0*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes doccheck question Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Android Security Essentials Live Lessons this week in the Android forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "doccheck question" Watch "doccheck question" New topic
Author

doccheck question

Axel Leucht
Greenhorn

Joined: Jan 19, 2009
Posts: 21
I'm currently in the finishing stage of my URLyBird assignment and do check my generated javadoc with the doccheck tool from SUN.

What concerns my is that the tool complains about one file mentioning it is missing tags for a particular method.

The class (A) implements an interface (B) and do /** {@inheritDoc}. */ for the three interface methods. I don't understand why it doesn't complain about the other methods but just one.

The generated javadoc html looks good. Some minor points I wonder are that method-1 gets "Specified by" sentence inside but method gets "Description copied from interface" and the third method (the one where dochceck complains about) looks good like method-1.

My assumption was that the dochceck tool should generate no warnings with the inheritDoc annotation when the javadoc of the superclass/interface are ok and should generate "Description copied from..." in the HTML file.

Does anyone of you have any hints as to how to handle this situation?

Thanks in advance.


Regards

SCJP, SCJD
Roel De Nijs
Bartender

Joined: Jul 19, 2004
Posts: 5139
    
  12

Hi Axel,

I used the doccheck tool after I submitted my project and I don't think it has any added value. If you use an IDE (like Eclipse) while developing and you generate javadoc you'll get also warnings if you forgot something or made a mistake.

My read-method looks like this in my Data-class (javadoc comments in my custom interface DAO, extending Sun's interface DBMain):

The generated javadoc comments look like this:

Reads a record.

Specified by: read in interface DAO
Specified by: read in interface DBMain
...

So only "specified by" clause, no "Description copied from..."-clause.

Kind regards,
Roel


SCJA, SCJP (1.4 | 5.0 | 6.0), SCJD
http://www.javaroe.be/
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: doccheck question
 
Similar Threads
Coding Standards
Submission Jar: test case + Ant build script
JavaDoc for methods from interfaces
javadoc for implementing public methods
about javadoc