United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
JDK-4695326 : stddoclet: Enable "-tag name" shortcut for "-tag name:a:name"

Details
Type:
Enhancement
Submit Date:
2002-05-31
Status:
Resolved
Updated Date:
2014-05-05
Project Name:
JDK
Resolved Date:
2002-10-25
Component:
tools
OS:
windows_2000
Sub-Component:
javadoc(tool)
CPU:
x86
Priority:
P4
Resolution:
Fixed
Affected Versions:
1.4.0
Fixed Versions:
1.4.2 (mantis)

Related Reports

Sub Tasks

Description

Name: nt126004			Date: 05/31/2002


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


A DESCRIPTION OF THE PROBLEM :
When running javadoc -d javadoc -tag pre
bugs/jdk/JavadocCustomTag.java on the source below I should
see all @pre tags grouped together just like the @param
tags.  Instead I get output from javadoc that no such tags
were found.


EXPECTED VERSUS ACTUAL BEHAVIOR :
Actual results:
Loading source file bugs/jdk/JavadocCustomTag.java...
Constructing Javadoc information...
Standard Doclet version 1.4.0

Generating javadoc\constant-values.html...
Building tree for all the packages and classes...
Building index for all the packages and classes...
Generating javadoc\overview-tree.html...
Generating javadoc\index-all.html...
Generating javadoc\deprecated-list.html...
Building index for all classes...
Generating javadoc\allclasses-frame.html...
Generating javadoc\allclasses-noframe.html...
Generating javadoc\index.html...
Generating javadoc\packages.html...
Generating javadoc\bugs\jdk\package-frame.html...
Generating javadoc\bugs\jdk\package-summary.html...
Generating javadoc\bugs\jdk\package-tree.html...
Generating javadoc\bugs\jdk\JavadocCustomTag.html...
Generating javadoc\package-list...
Generating javadoc\help-doc.html...
Generating javadoc\stylesheet.css...
Note: Custom tags that could override future standard tags:
 @pre. To avoid potential overrides, use at least one period
character (.) in custom tag names.
Note: Custom tags that were not seen:  @pre


This bug can be reproduced always.

---------- BEGIN SOURCE ----------
package bugs.jdk;

public class JavadocCustomTag {

  /**
   * @param args ignored
   * @pre some custom tag
   */
  public static void main(final String[] args) {

  }
  
}

---------- END SOURCE ----------

CUSTOMER WORKAROUND :
Write your own doclet.  I have one for 1.3, unfortunatly 1.4
changed the standard doclet enough that a rewrite is required.
(Review ID: 147256) 
======================================================================

                                    

Comments
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
mantis

FIXED IN:
mantis

INTEGRATED IN:
mantis
mantis-b05


                                     
2004-06-14
PUBLIC COMMENTS

The standard doclet now supports "-tag pre" as a shortcut for "-tag pre:a:Pre:".
                                     
2004-06-10
EVALUATION

It is a user error -- the submitter should specify -tag pre:a:"Pre:"

However, it is reasonable to have a simpler syntax for this.
We should allow the simpler syntax 

  -tag pre 

be equivalent to 

  -tag pre:a:"pre"

Changed from bug to rfe and changed synopsis from:
  -tag switch not working in Javadoc
to: 
  Enable "-tag name" shortcut for "-tag name:a:name"

###@###.### 2002-05-31

I have fixed this bug. The bug fix is pending review.
###@###.### 2002-07-08
                                     
2002-05-31



Hardware and Software, Engineered to Work Together