JDK-4651598 : REGRESSION: Javadoc wrongly inserts </DD> tags when using multiple @author tags
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.4.0
  • Priority: P3
  • Status: Resolved
  • Resolution: Fixed
  • OS: windows_nt
  • CPU: x86
  • Submitted: 2002-03-12
  • Updated: 2014-05-05
  • Resolved: 2002-04-25
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 Availabitlity Release.

To download the current JDK release, click here.
Other
1.4.1 hopperFixed
Description

Name: nt126004			Date: 03/12/2002


FULL PRODUCT VERSION :
C:\>java -version
java version "1.4.0"
Java(TM) 2 Runtime Environment, Standard Edition
(build 1.4.0-b92)
Java HotSpot(TM) Client VM (build 1.4.0-b92, mixed mode)

FULL OPERATING SYSTEM VERSION : NT  40 sp6


ADDITIONAL OPERATING
SYSTEMS :



A DESCRIPTION OF THE PROBLEM :
  From Javadoc in Java source code:
/**
 * @author    Per Spilling
 * @author    Knut Erik Ballestad
 * @created   7. november 2001
 */

When
using multiple @author tags, I expected results as documented in the JDK
1.4 javadoc tool documentation at
http://java.sun.com/j2se/1.4/docs/tooldocs/win32/javadoc.html
:

It states:
@author name-text
Adds an "Author" entry with the
specified name-text to the generated docs when the -author option is used. A
doc comment may contain multiple @author tags. You can specify one name
per @author tag or multiple names per tag. In the former case, the Javadoc
tool inserts a comma (,) and space between names. In the latter case, the
entire text is simply copied to the generated document without being
parsed. Therefore, use multiple names per line if you want a localized
name separator other than comma.

Instead of simply using commas for
separation, some undocumented HTML code are inserted, which messes up
the output generated by the javadoc tool.

STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
1. Simple generate som javacode from a java file with multiple @author
tags.


EXPECTED VERSUS ACTUAL BEHAVIOR :
Expected generated javadoc HTML code:
Generated javadoc html
code:
<DT><B>Version:</B>
   <DD>4.0 $Revision: 1.14
$</DD>
</DT>
<DT><B>Author:</B>
   <DD>Per Spilling, Knut Erik
Ballesta</DD>
</DT>

Actually generated javadoc HTML
code:
<DT><B>Version:</B>
   <DD>4.0 $Revision: 1.14
$</DD>
</DD>
<DT><B>Author:</B>
   <DD>Per Spilling</DD>
   , Knut
Erik Ballestad</DD>
</DD>



ERROR MESSAGES/STACK TRACES THAT OCCUR :
No error messages are reported.

This bug can be reproduced always.

---------- BEGIN SOURCE ----------
package com.nordea.coffee;
import java.io.Serializable;
import java.text.MessageFormat;

/**
 * @author    Per Spilling
 * @author    Knut Erik Ballestad
 */
public class CfSystemException extends RuntimeException {}
---------- END SOURCE ----------

CUSTOMER WORKAROUND :
Write the javadoc like this:
/**
 * @author    Per Spilling, Knut Erik
Ballestad
 */

Release Regression From : 1.3.1
The above release value was the last known release where this 
bug was known to work. Since then there has been a regression.

(Review ID: 143321) 
======================================================================

Comments
CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: hopper FIXED IN: hopper INTEGRATED IN: hopper
2004-06-14

EVALUATION Should be straightforward to fix. ###@###.### 2002-03-13 This bug was in SimpleTaglet.java, so affected all simple taglets, which are @author, @version and @since. Fixed for hopper. Regression test at: <ws>/test/com/sun/javadoc/AuthorDD/AuthorDD.java ###@###.### 2002-04-21
2002-04-21