Loading... (original) (raw)

Name: rmT116609 Date: 08/14/2003

FULL PRODUCT VERSION :
java version "1.4.1_02"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.1_02-b06)
Java HotSpot(TM) Client VM (build 1.4.1_02-b06, mixed mode)

java version "1.4.2"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2-b28)
Java HotSpot(TM) Client VM (build 1.4.2-b28, mixed mode)

FULL OS VERSION :
Windows NT Version 4.0
(this is Deutsche bank's internal build, based off of sp6 I believe)

A DESCRIPTION OF THE PROBLEM :
If I am writing a javadoc with an @see line that refers to a book or other printed source, the proper (semanticly meaningful) html tag to use is the tag.

For instance, I should write something like

* @see The Handbook Of Fixed Income Securities, Sixth Edition, Frank J. Fabozzi (Editor), McGraw-Hill 2001 p.124

When execute javadoc, however, on a java source file with a javadoc comment with a line like that, I get spurious warning like:

XXX.java:78: warning - Tag @see:
missing final >: "The Handbook Of Fixed Income Securities, Sixth Edition, Frank J. Fabozzi (Editor), McGraw-Hill 2001 p.124"

This is clearly an error: my html is properly written, with a closing () tag and all.

It is a spurious warning because the actual html doc file that is generated displays fine in browsers (i.e. the text inside is italicized).

(Well, looking closer at the actual html generated, I am not sure that its syntax is fully correct. For instance, in this case there will be the line

See Also:

The Handbook Of Fixed Income Securities, Sixth Edition, Frank J. Fabozzi (Editor), McGraw-Hill 2001 p.124

which looks like it does not properly close all tags like

etc. But it does display fine in IE and Mozilla.

This brings up another point: could you please clean up the javadoc tool so that it actually generates cleaner html?

In particular, it would be nice if you generated xhtml output which satisfies the strct xhtml 1.0 DTD.)
which

STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
try to javadoc the following source file:

/**
* @see The Handbook Of Fixed Income Securities, Sixth Edition, Frank J. Fabozzi (Editor), McGraw-Hill 2001 p.124
*/
public class JavadocBug {}

you should see output from javadoc something like

JavadocBug.java:6: warning - Tag @see: missing final >: "The Handbook Of Fixed Income Securities, Sixth Edition, Frank J. Fabozzi (Editor), McGraw-
Hill 2001 p.124"

EXPECTED VERSUS ACTUAL BEHAVIOR :
EXPECTED -
No warning from javadoc

REPRODUCIBILITY :
This bug can be reproduced always.
(Incident Review ID: 189511)
======================================================================