United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: 4893808 REGRESSION: custom tags containing '-' e.g. @ejb.ejb-ref gives warning
4893808 : REGRESSION: custom tags containing '-' e.g. @ejb.ejb-ref gives warning

Details
Type:
Bug
Submit Date:
2003-07-21
Status:
Closed
Updated Date:
2003-10-08
Project Name:
JDK
Resolved Date:
2003-10-08
Component:
docs
OS:
windows_2000
Sub-Component:
doclet
CPU:
x86
Priority:
P3
Resolution:
Duplicate
Affected Versions:
1.4.2
Fixed Versions:

Related Reports
Duplicate:

Sub Tasks

Description

Name: rmT116609			Date: 07/21/2003


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 :
Microsoft 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) 
======================================================================

                                    

Comments
EVALUATION

Accepted.
###@###.### 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.
###@###.### 2003-10-07
                                     
2003-09-23



Hardware and Software, Engineered to Work Together