JDK-4034756 : javadoc template: add summary lines to individual package index files
  • 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 :  
Description
The individual package index files (i.e., Package-<package-name>.html) would be more useful if each Interface, Class, Exception, and Error listed were augmented with a brief summary of that entity.  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).  By convention, the summary could be the first sentence from the entity's top-level doc comment, following the analogy. 


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

PUBLIC COMMENTS To implement this, I modified packageSummary.jdtl by adding the first sentence of the doc comment under each interface, class, exception, and error name. chris.bucchere@Eng 1997-09-18 Tested in JDK1.2Beta4-G. Now read from fisrt line of package.html and put it in the packages summary table in file overview-summary.html dianne.jiao@East 1998-05-26
18-09-1997

EVALUATION Will implement using jdtl. chris.bucchere@Eng 1997-09-18 Needs to be re-implemented by Atul in the Standard Doclet doug.kramer@Eng 1997-11-25
18-09-1997