United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-6851834 Javadoc doclet needs a structured approach to generate the output HTML.
JDK-6851834 : Javadoc doclet needs a structured approach to generate the output HTML.

Details
Type:
Enhancement
Submit Date:
2009-06-16
Status:
Closed
Updated Date:
2011-03-11
Project Name:
JDK
Resolved Date:
2011-03-08
Component:
docs
OS:
other,linux,generic
Sub-Component:
doclet
CPU:
x86,generic
Priority:
P4
Resolution:
Fixed
Affected Versions:
1.4.0,1.4.2,5.0,5.0u7,6,7
Fixed Versions:

Related Reports
Duplicate:
Duplicate:
Duplicate:
Duplicate:
Duplicate:
Relates:
Relates:

Sub Tasks

Description
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.

                                    

Comments
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.
                                     
2009-06-16
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.
                                     
2009-06-16
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
                                     
2010-11-30
EVALUATION

http://hg.openjdk.java.net/jdk7/build/langtools/rev/90af8d87741f
                                     
2010-12-25



Hardware and Software, Engineered to Work Together