United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-4651598 REGRESSION: Javadoc wrongly inserts </DD> tags when using multiple @author tags
JDK-4651598 : REGRESSION: Javadoc wrongly inserts tags when using multiple @author tags

Details
Type:
Bug
Submit Date:
2002-03-12
Status:
Resolved
Updated Date:
2002-04-25
Project Name:
JDK
Resolved Date:
2002-04-25
Component:
docs
OS:
windows_nt
Sub-Component:
doclet
CPU:
x86
Priority:
P3
Resolution:
Fixed
Affected Versions:
1.4.0
Fixed Versions:
1.4.1 (hopper)

Related Reports

Sub Tasks

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
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
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
hopper

FIXED IN:
hopper

INTEGRATED IN:
hopper


                                     
2004-06-14



Hardware and Software, Engineered to Work Together