Bug 255355 - Add package descriptions and overview text to SDD javadoc
Summary: Add package descriptions and overview text to SDD javadoc
Status: NEW
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Cosmos (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Jason Losh CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-11-14 10:20 EST by David Whiteman CLA
Modified: 2012-01-03 13:48 EST (History)
1 user (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description David Whiteman CLA 2008-11-14 10:20:08 EST 
If you notice the Javadoc for the JDK, there is nice summary text at the beginning of the javadoc, plus there are package descriptions to the right of each package name on the front page.  Here's an example of what they do:

http://java.sun.com/j2se/1.4.2/docs/api/

Here's what the SDD javadoc front page looks like currently:

http://download.eclipse.org/technology/cosmos/1.0.0/javadoc/sdd/public/index.html

Here's how to create the package level comments:

http://java.sun.com/j2se/javadoc/writingdoccomments/#packagecomments