JDK-1226555 : javadoc template: Add option for header to identify document on each HTML page
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.0
  • Priority: P2
  • Status: Closed
  • Resolution: Fixed
  • OS: solaris_2.4
  • CPU: sparc
  • Submitted: 1995-10-31
  • 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 :  
JDK-4034752 - javadoc: allow user-specified footers on all generated pages
Relates :  
JDK-4034280 - Allow package-level comments in topmost packages.html file
Description
API documentation should produce identifying information at the top of each HTML page.  Our current javadoc output all looks the same, and it's easy for a user to consult the API doc pages for the wrong version and not be aware of it.

For example:

	-title "Java(tm) Platform API 1.1.1"

as an option to javadoc could place the argument (a string of HTML text) as the major title of the packages.html file as well as the subtitle on other generated pages.
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
SUGGESTED FIX Implement either as an option at the command line, or better yet as a resource file to the templates.
11-06-2004
PUBLIC COMMENTS Template is no longer in use. -header option is implemented in standard doclet. Tested in JDK1.2Beta4-F. dianne.jiao@East 1998-05-19
19-05-1998
EVALUATION Should be easy to fix with templates doug.kramer@Eng 1997-10-07
07-10-1997