• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Jeanne Boyarsky
  • Ron McLeod
  • Paul Clapham
  • Liutauras Vilda
Sheriffs:
  • paul wheaton
  • Rob Spoor
  • Devaka Cooray
Saloon Keepers:
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
  • Frits Walraven
  • Tim Moores
Bartenders:
  • Mikalai Zaikin

doccheck question

 
Greenhorn
Posts: 21
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • 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.
 
Sheriff
Posts: 11604
178
Hibernate jQuery Eclipse IDE Spring MySQL Database AngularJS Tomcat Server Chrome Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • 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,
Roel
 
Get off me! Here, read this tiny ad:
a bit of art, as a gift, the permaculture playing cards
https://gardener-gift.com
reply
    Bookmark Topic Watch Topic
  • New Topic