|
Quick Lists
|
|
Bug ID:
|
4695326
|
|
Votes
|
0
|
|
Synopsis
|
stddoclet: Enable "-tag name" shortcut for "-tag name:a:name"
|
|
Category
|
doclet:tbd
|
|
Reported Against
|
1.4
|
|
Release Fixed
|
1.4.2(mantis)
|
|
State
|
10-Fix Delivered,
request for enhancement
|
|
Priority:
|
4-Low
|
|
Related Bugs
|
|
|
Submit Date
|
31-MAY-2002
|
|
Description
|
The standard doclet now supports "-tag pre" as a shortcut for "-tag pre:a:Pre:".
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)
======================================================================
|
|
Work Around
|
N/A
|
|
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
Enable "-tag name" shortcut for "-tag name:a:name"
xxxxx@xxxxx 2002-05-31
I have fixed this bug. The bug fix is pending review.
xxxxx@xxxxx 2002-07-08
|
|
Comments
|
PLEASE NOTE: JDK6 is formerly known as Project Mustang
|
|
|
 |