This week's book giveaway is in the Java 8 forum.
We're giving away four copies of Java 8 in Action and have Raoul-Gabriel Urma, Mario Fusco, and Alan Mycroft on-line!
See this thread for details.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Package Description Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login

Win a copy of Java 8 in Action this week in the Java 8 forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Package Description" Watch "Package Description" New topic

Package Description

Amit Kr Kumar
Ranch Hand

Joined: Feb 08, 2002
Posts: 100
Hi Ranchers
I am planning to provide package description for each package e.g client, server, db, common in javadoc
What should this description contain ?
How others have done it ?
Pls Guide
Amit Kr Kumar
Ranch Hand

Joined: Feb 08, 2002
Posts: 100
Team any suggestion please for the above query

Robin Underwood
Ranch Hand

Joined: May 01, 2002
Posts: 117
You might want to explain how the classes in the package work together. A UML class diagram could show this visually.
I think the package comments are completely optional so I wouldn't worry about it.
I agree. Here's the link:
subject: Package Description
Similar Threads
NX: URLy Bird 1.3.1 JavaDocs
Javadoc for Package
is there necessary create a package.html?
How to include package info into Javadocs
WA #1.....word association