This week's book giveaway is in the Cloud/Virtualization forum.
We're giving away four copies of Kubernetes in Action and have Marko Luksa on-line!
See this thread for details.
Win a copy of Kubernetes in Action this week in the Cloud/Virtualization forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic

doccheck question  RSS feed

Posts: 21
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
Posts: 11338
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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,
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!