Java Solaris Communities Sun Store Join SDN My Profile Why Join?
 
Bug Database
Bug Detail
Quick Lists
Top 25 Bugs
Top 25 RFE's
Recently Closed Bugs
Printable Page Printable Page


Bug Database
Bug ID: 4893808
Votes 3
Synopsis REGRESSION: custom tags containing '-' e.g. @ejb.ejb-ref gives warning
Category doclet:tbd
Reported Against 1.4.2
Release Fixed
State 11-Closed, duplicate of 4920381, bug
Priority: 3-Medium
Related Bugs 4920381
Submit Date 21-JUL-2003
Description




FULL PRODUCT VERSION :
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 :
 customer  Windows 2000 [Version 5.00.2195]

A DESCRIPTION OF THE PROBLEM :
Javadoc generates warning for all custom tags that contain '-' e.g. @ejb.ejb-ref
This makes it impossible to see acctual warnings when using tools like XDoclet.

STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
The java-file:
test/javadoc/CustomTagTest.java
run:
javadoc -tag test.ok -tag test.will-fail -sourcepath . test.javadoc


EXPECTED VERSUS ACTUAL BEHAVIOR :
EXPECTED -
prompt>javadoc  -tag test.ok -tag test.will-fail -sourcepath . test.javadoc

Loading source files for package test.javadoc...
Constructing Javadoc information...
Standard Doclet version 1.4.1

Generating constant-values.html...
Building tree for all the packages and classes...
Building index for all the packages and classes...
Generating overview-tree.html...
Generating index-all.html...
Generating deprecated-list.html...
Building index for all classes...
Generating allclasses-frame.html...
Generating allclasses-noframe.html...
Generating index.html...
Generating packages.html...
Generating test\javadoc\package-frame.html...
Generating test\javadoc\package-summary.html...
Generating test\javadoc\package-tree.html...
Generating test\javadoc\CustomTagTest.html...
Generating package-list...
Generating help-doc.html...
Generating stylesheet.css...
Note: Custom tags that were not seen:  @test.will-fail, @test.ok
ACTUAL -
Loading source files for package test.javadoc...
Constructing Javadoc information...
Standard Doclet version 1.4.2
Generating constant-values.html...
Building tree for all the packages and classes...
Building index for all the packages and classes...
Generating overview-tree.html...
Generating index-all.html...
Generating deprecated-list.html...
Building index for all classes...
Generating allclasses-frame.html...
Generating allclasses-noframe.html...
Generating index.html...
Generating packages.html...
Generating test\javadoc\package-frame.html...
Generating test\javadoc\package-summary.html...
Generating test\javadoc\package-tree.html...
Generating test\javadoc\CustomTagTest.html...
D:\\.\test\javadoc\CustomTagTest.java:10: warning - @test.will-fail is an unknown tag.
Generating package-list...
Generating help-doc.html...
Generating stylesheet.css...
Note: Custom tags that were not seen:  @test.will
1 warning

REPRODUCIBILITY :
This bug can be reproduced always.

---------- BEGIN SOURCE ----------
package test.javadoc;

/**
 * A javadoc custom tag test.
 *
 * @test.ok
 *
 * @test.will-fail
 */
public class JavaDocTest {
   public JavaDocTest() {
   }
}

---------- END SOURCE ----------
(Incident Review ID: 190689) 
======================================================================
Work Around
N/A
Evaluation
Accepted.
  xxxxx@xxxxx   2003-09-23

This is the same bug as 4920381.  Instead of using - as a default seperator, we have to escape : when the user wants to use it in the tag name.
  xxxxx@xxxxx   2003-10-07
Comments
  
  Include a link with my name & email   

Submitted On 08-AUG-2003
jlweb1958
This bug is irritating -- custom javadoc tags with a hyphen
are becoming quite frequent (i.e. Jakarta Avalon project).



PLEASE NOTE: JDK6 is formerly known as Project Mustang