File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Adding JavaDocs to the DB interface Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login

Win a copy of EJB 3 in Action this week in the EJB and other Java EE Technologies forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Adding JavaDocs to the DB interface" Watch "Adding JavaDocs to the DB interface" New topic

Adding JavaDocs to the DB interface

Cleverson Schmidt
Ranch Hand

Joined: Feb 17, 2004
Posts: 55
Hi everyone

I've changed the interface provided by Sun, in my assignment it is called DB, to generate correct JavaDocs. I didn't change any method signature or any other sensitive information, just the comments, adding some @param here and @return there. I know we are not suppose to touch this interface, but do you think I did the wrong thing changing its comments to conform to the JavaDocs style?

Any coments are welcome
Thank you very much

Best Regards
Andrew Monkhouse
author and jackaroo
Marshal Commander

Joined: Mar 28, 2003
Posts: 11278

Hi Cleverson,

I think that what you are doing is perfect. We do need to provide JavaDoc for all submitted classes and interfaces, so we have to change the provided comments (IMHO). As long as you don't touch the method signatures you are fine.

Regards, Andrew

The Sun Certified Java Developer Exam with J2SE 5: paper version from Amazon, PDF from Apress, Online reference: Books 24x7 Personal blog
Cleverson Schmidt
Ranch Hand

Joined: Feb 17, 2004
Posts: 55
Thank you Andrew
This forum is the greatest

I agree. Here's the link:
subject: Adding JavaDocs to the DB interface
Similar Threads
nx:All of URLy Bird 1.1.3 about javadoc comments
[URLyBird] Javadoc comments
swap the xml thorugh java class
I want to ask 2 questions about javadoc.
executing jar file