• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Adding JavaDocs to the DB interface

 
Cleverson Schmidt
Ranch Hand
Posts: 55
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Cleverson
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 11866
194
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
 
Cleverson Schmidt
Ranch Hand
Posts: 55
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thank you Andrew
This forum is the greatest

Cleverson
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic