United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-4628181 stddoclet: Option -tag tagname:X must include taghead
JDK-4628181 : stddoclet: Option -tag tagname:X must include taghead

Details
Type:
Bug
Submit Date:
2002-01-24
Status:
Resolved
Updated Date:
2002-12-05
Project Name:
JDK
Resolved Date:
2002-10-25
Component:
docs
OS:
solaris_8,linux
Sub-Component:
doclet
CPU:
x86,sparc
Priority:
P4
Resolution:
Fixed
Affected Versions:
1.4.0
Fixed Versions:
1.4.2 (mantis)

Related Reports

Sub Tasks

Description

Name: nt126004			Date: 01/24/2002


FULL PRODUCT VERSION :
java version "1.4.0-beta3"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.0-beta3-b84)
Java HotSpot(TM) Client VM (build 1.4.0-beta3-b84, mixed mode)

FULL OPERATING SYSTEM VERSION :
SunOS aloysius 5.8 Generic_108528-05 sun4u sparc
SUNW,Ultra-5_10



A DESCRIPTION OF THE PROBLEM :
May be simple doc bug.  Dox suggest that -tag name:X
is acceptable (cf http://java.sun.com/j2se/1.4/docs/tooldocs/solaris/javadoc.html#tag
).  However, -tag blahtag:X actually gets me:

javadoc: Error - blahtag:X is an invalid argument to the
-tag option...


This bug can be reproduced always.

CUSTOMER WORKAROUND :
Just make sure to provide a dummy taghead:
-tag blahtag:X:Quack
(Review ID: 138434) 
======================================================================

                                    

Comments
PUBLIC COMMENTS

This bug has been fixed.
###@###.### 2002-06-01
                                     
2002-06-01
EVALUATION

This option:

  -tag beaninfo:X 

produces this error:

   javadoc: Error - beaninfo:X is an invalid argument to the -tag option...

###@###.### 2002-03-25

I've added the -tag beaninfo:X tag to the J2SE hopper makefile, so this bug 
needs to be fixed for hopper
###@###.### 2002-03-25

I made a counting error when parsing -tag arguments in the following format:

-tag <tagName>:X

I used the string tokenizer "new StringTokenizer(args[1], ":", true)" and
thought that the argument was 2 tokens.  It is actually 3 tokens because the ":"
is not thrown away.

This bug fix is pending review.
###@###.### 2002-07-08
                                     
2002-07-08
WORK AROUND

As mentioned by the submitter, the workaround is to include any tag heading 
as the third term -- it will be ignored (not printed in the output) but will 
allow the option to suppress error messages.  For example, "Quack":

  -tag blahtag:X:Quack

###@###.### 2002-10-17
                                     
2002-10-17
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
mantis

FIXED IN:
mantis

INTEGRATED IN:
mantis
mantis-b05


                                     
2004-06-14



Hardware and Software, Engineered to Work Together