JDK-4034759 : javadoc template: Add one-line summary for each package in topmost Package Index
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.1
  • Priority: P2
  • Status: Closed
  • Resolution: Fixed
  • OS: solaris_2.5.1
  • CPU: generic
  • Submitted: 1997-02-26
  • Updated: 2014-05-05
  • Resolved: 1999-01-19
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
Other
1.2.0 1.2beta3Fixed
Related Reports
Relates :  
Relates :  
Description
The top-level Package Index file (i.e., packages.html) would be more useful if each package listed were augmented with a brief summary of that package.  This is analogous to the one-line summary information that appears for the Field, Constructor, and Method Indexes at the top of each class file (i.e., <package-name>.<class-name>.html).  This will be especially useful when javadoc is once again used to generate hardcopy documentation (such as -doctype MIF).


Comments
CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: generic FIXED IN: 1.2beta3 INTEGRATED IN: 1.2beta3 VERIFIED IN: 1.2beta4
14-06-2004

WORK AROUND
11-06-2004

SUGGESTED FIX Since there is no obvious existing place to store the text of the summary information for each package, probably the simplest implementation is to have a filenaming convention for where javadoc should find the information. For example, each package's directory could contain a file named, say, package.comment, that contains the information to be inserted into the packages.html file.
11-06-2004

PUBLIC COMMENTS dianne.jiao@East 1998-05-26 Tested in JDK1.2Beta4-G. Now read package.html file in packages and output in package-summary.html.
26-05-1998

EVALUATION Let's do this for JDK 1.2 since it can be done in the templates. doug.kramer@Eng 1997-10-07 Done in Standard doclet. robert.field@Eng 1998-01-06
07-10-1997