wood burning stoves 2.0*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes JavaDoc package and class description Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "JavaDoc package and class description" Watch "JavaDoc package and class description" New topic
Author

JavaDoc package and class description

K. Tsang
Bartender

Joined: Sep 13, 2007
Posts: 2242
    
    7

Hello, I'm finishing up my assignment and want to ask about the javadoc for the package and class level.

How much description is needed for a package and class? Currently I use a one-liner describing the purpose of the package or class. Is it necessary to expand this by say including how this class is used in my application etc?

Thanks.

K. Tsang JavaRanch SCJP5 SCJD/OCM-JD OCPJP7 OCPWCD5
 
Consider Paul's rocket mass heater.
 
subject: JavaDoc package and class description
 
Similar Threads
Javadoc for Package
NX: URLy Bird 1.3.1 JavaDocs
Package Description
JavaDoc and package index
[ant] javadoc task