This week's giveaway is in the EJB and other Java EE Technologies forum.
We're giving away four copies of EJB 3 in Action and have Debu Panda, Reza Rahman, Ryan Cuprak, and Michael Remijan on-line!
See this thread for details.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Javadoc for Package 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 "Javadoc for Package" Watch "Javadoc for Package" New topic
Author

Javadoc for Package

Sam Codean
Ranch Hand

Joined: Feb 26, 2006
Posts: 194
Does anyone know how to generate javadoc comments for the Package? I tried adding it before the package declaration in one class from that package but it did not work.


-Sam Codean<br />SCJP 1.4 (98%)<br />SCJD 5.0 (87.5%)
Petr Hejl
Ranch Hand

Joined: Feb 26, 2006
Posts: 68
Try to google for package-info.java. It will tell you more
Mihai Radulescu
Ranch Hand

Joined: Sep 18, 2003
Posts: 916

Hi

You need a package.html in each package. You can find a description in
"How to Write Doc Comments", chapter "Package-Level Comments".
You can get this document from the java.sun.com(javadoc page).

Regards M


SCJP, SCJD, SCWCD, OCPJBCD
Petr Hejl
Ranch Hand

Joined: Feb 26, 2006
Posts: 68
This is true for jdk1.4 and still can be used in jdk5, but starting with jdk5 the package level info (there can be more than just javadoc) should be placed in package-info.java.
Sam Codean
Ranch Hand

Joined: Feb 26, 2006
Posts: 194
Thank you !!
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: Javadoc for Package
 
Similar Threads
How can you check for the existance of system packages?
package.html in src - should it be removed?
NX: Default Class Visibility
ready to upload, 1 question
Creating javadocs for "published" API vs public API