United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-4415270 stddoclet: HTML table tags inserted in wrong place in package use page (invalid)
JDK-4415270 : stddoclet: HTML table tags inserted in wrong place in package use page (invalid)

Details
Type:
Bug
Submit Date:
2001-02-14
Status:
Resolved
Updated Date:
2002-10-25
Project Name:
JDK
Resolved Date:
2002-10-25
Component:
docs
OS:
solaris_2.6
Sub-Component:
doclet
CPU:
sparc
Priority:
P4
Resolution:
Fixed
Affected Versions:
1.3.0
Fixed Versions:
1.4.2 (mantis)

Related Reports

Sub Tasks

Description
On the package use pages (package-use.html), the heading for all the class
tables has these tags inserted at the wrong place:
 
</TR>
</FONT></TD>

They are mistakenly inserted at the end of the table, many rows after 
their start tags.  They should appear in a different order, ahead of 
the start of the second row in that table:

</FONT></TD></TR>
<TR BGCOLOR="white" CLASS="TableRowColor">

Both Netscape and IE seem to interpret the files correctly, however,
it would be better to generate proper HTML.

----------------------------
For example, see:
http://webwork.eng/j2se/1.3/docs/api/java/lang/ref/package-use.html

The second table starts with "Classes in java.lang.ref used by java.lang.ref"

Javadoc currently generates:
(Notice that the first row contains a cell that spans 2 columns and that the 
second row should start immediately after that cell.  Instead, the <TR> for that
second row is missing and the second row starts with <TD>.  Also notice that the
</FONT> is in the wrong place -- it comes far too late (since <FONT> tags cannot 
span cells), many rows later.  I've marked the bad end tags </TR></FONT></TD>
with ^^^^^^ below them.
--------- START ----------
<A NAME="java.lang.ref"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
Classes in <A HREF="../../../java/lang/ref/package-summary.html">java.lang.ref</A> used by 
<A HREF="../../../java/lang/ref/package-summary.html">java.lang.ref</A><TR BGCOLOR="white" CLASS="TableRowColor">
<TD><B><A HREF="../../../java/lang/ref/class-use/Reference.html#java.lang.ref"><B>Reference</B></A></B>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Abstract base class for reference objects.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><B><A HREF="../../../java/lang/ref/class-use/ReferenceQueue.html#java.lang.ref"><B>ReferenceQueue</B></A></B>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reference queues, to which registered reference objects are appended by the
 garbage collector after the appropriate reachability changes are detected.</TD>
</TR>
^^^^^
</FONT></TD>
^^^^^^^^^^^^
</TR>
</TABLE>
---------- END ----------

What Javadoc should generate:
I've marked the correctly positioned </FONT></TD></TR> tags with ^^^^^^ below them.

--------- START ----------
<A NAME="java.lang.ref"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
Classes in <A HREF="../../../java/lang/ref/package-summary.html">java.lang.ref</A> used by 
<A HREF="../../../java/lang/ref/package-summary.html">java.lang.ref</A>
</FONT></TD></TR>
^^^^^^^^^^^^^^^^^
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><B><A HREF="../../../java/lang/ref/class-use/Reference.html#java.lang.ref"><B>Reference</B></A></B>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Abstract base class for reference objects.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><B><A HREF="../../../java/lang/ref/class-use/ReferenceQueue.html#java.lang.ref"><B>ReferenceQueue</B></A></B>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reference queues, to which registered reference objects are appended by the
 garbage collector after the appropriate reachability changes are detected.</TD>
</TR>
</TABLE>
------ END -------

                                    

Comments
EVALUATION

Important to generate valid HTML
###@###.### 2002-08-30
                                     
2002-08-30
PUBLIC COMMENTS

Fixed by moving tableHeaderEnd() earlier in generateClassList()
in PackageUserWriter.java

Regression test at:
<ws>/test/com/sun/javadoc/ValidHtml/ValidHtml.java

###@###.### 2002-09-25
                                     
2002-09-25
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
mantis

FIXED IN:
mantis

INTEGRATED IN:
mantis
mantis-b05


                                     
2004-06-14



Hardware and Software, Engineered to Work Together