wood burning stoves*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes incomplete javadoc 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 "incomplete javadoc" Watch "incomplete javadoc" New topic

incomplete javadoc

Cathy Young
Ranch Hand

Joined: Mar 02, 2002
Posts: 126
Among the javadoc comments provided in the source code, (Data.java, DataInfo.java, FieldInfo.java) there are several incomplete comments (for example, did not specify the return type for a method which returns int). Are we supposed to complete them, or just leave it as it if we did not change anything in that method? Can someone clarify it for me? Thanks a lot! --Cathy
Michael Morris
Ranch Hand

Joined: Jan 30, 2002
Posts: 3451
Hi Cathy,
I did. It seems logical to do so. I think they want to see how thorough we are by "baiting" us with inclomplete javadoc comments.
Just my dos centavos,
Michael Morris

Any intelligent fool can make things bigger, more complex, and more violent. It takes a touch of genius - and a lot of courage - to move in the opposite direction. - Ernst F. Schumacher
Cathy Young
Ranch Hand

Joined: Mar 02, 2002
Posts: 126
Thanks, Michael! I think I will just follow what you did.
It is sorta covered in the JavaRanch Style Guide.
subject: incomplete javadoc
Similar Threads
May I refactor provided interface?
JavaDoc All variables?
generating own depricated method
Help, How much documentation is appropriate??
NX: Bodgitt and Scarper: may I modify the javadoc of the interface DB.java?