JDK-6851834 : Javadoc doclet needs a structured approach to generate the output HTML.
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.4.0,1.4.2,5.0,5.0u7,6,7
  • Priority: P4
  • Status: Closed
  • Resolution: Fixed
  • OS: generic,other,linux
  • CPU: generic,x86
  • Submitted: 2009-06-16
  • Updated: 2014-05-05
  • Resolved: 2011-03-08
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.
7 b123Fixed
Related Reports
Duplicate :  
Duplicate :  
Duplicate :  
Duplicate :  
Duplicate :  
Relates :  
The javadoc/doclet tool should have a structured approach to generating the output HTML. There are a bunch of print statements all over the doclet which should be replaced by objects which could be used to generate an HTML tree which can then be printed out.

Current implementation generates invalid and inaccessible HTML output.

EVALUATION http://hg.openjdk.java.net/jdk7/build/langtools/rev/90af8d87741f

SUGGESTED FIX This implementation should generate valid and accessible HTML output since it generates a valid HTML tree before printing it out to the output file. Also,we will be implementing style classes to render the output pages correctly. In addition to the archiotecture mentioned earlier, we will have more Content classes to support various output types. Following are the output content types 1. HtmlDocument 2. DocType 3. HtmlTree 4. StringContent 5. Comment 6. HtmlTag 7. HtmlStyle 8. HtmlAttr 9. RawHtml

SUGGESTED FIX The doclet should be able to generate different type of contents that form the javadoc output. Am HTML document generation framework needs to be implemented in the doclet which will create the following contents 1) HtmlDocument 2) DocType 3) HtmlTree 4) StringContent 5) Comment 6) HtmlTag The framework implemented should be used to generate the output markup within the doclet code.

EVALUATION The doclet should provide a facility to create HTMLTree objects which could be used to generate the HTMLTree for a javadoc output page generated by the tool.