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: 4039014
Votes 0
Synopsis stddoclet: Tag listener - Flag misspelled tags while printing custom tags
Category doclet:tbd
Reported Against 1.1 , 1.2
Release Fixed 1.4(merlin-beta2)
State 10-Fix Delivered, Verified, request for enhancement
Priority: 5-Very Low
Related Bugs 4220213
Submit Date 14-MAR-1997
Description
This RFE has been implemented.  The CustomTagFactory now has a method to check an array of Tags[] to make sure that they are all valid tags.  If any tags are unknown, an error message like this one is printed:

/home/jamieh/stddoclettests/sample-src/com/package1/Class1.java:65: warning - Warning - @sea is an unknown tag.

 xxxxx@xxxxx  2001-07-06This request is the merging of two requests:  Want to flag misspelled
tags as mistakes, but print custom tags.

REQUEST #1
If javadoc encounters a doc-comment tag that it doesn't recognize, such as:

	* @sea java.lang.String

(which is obviously a typographical error), javadoc simply ignores the entire tagged paragraph and neither issues an error message nor includes the text of the paragraph in the output HTML file.

This behavior makes it very difficult for writers of doc comments to debug their work.  So unless the JLS *requires* this behavior (which would be a JLS bug, IMHO), javadoc should at least issue an error message.

REQUEST #2  (from 4039014)
Display custom tags rather than ignoring them.  In the following example,
@precondition should be printed with a bold subheading "Precondition"
with its text following it.

   public class X{
        /**
         * the custom tag is ignored
         * @return this tag is working
         * @precondition this one is not displayed in the doc
         */
        public String Test() {
                    return "test";
        }
   }
Work Around
N/A
Evaluation
A doc checker doclet should be written.
 xxxxx@xxxxx  1997-12-08

Alan, is this something you can add to your docchecker doclet?
Perhaps provide a file listing all valid tags against which you
can check.
 xxxxx@xxxxx  1998-04-03

Reassigning to Eric, since he's now working on DocCheck doclet.
 xxxxx@xxxxx  1998-07-29

Although DocChecker could parse the text of the comment to identify
such errors, it would be redoing work that JavaDoc is already doing.
JavaDoc's recognizer should see * then @ and if it then does not
see a recognized keyword, it should generate an error.
Reassigning to the JavaDoc team, by way of Doug. (Possibly Atul should
get it?)
 xxxxx@xxxxx  1998-08-17

Making this change would require that the developer create a list of 
valid tags that javadoc inspects, since we now allow developers to make 
up their own custom tags.  Changing to P5, since this won't happen
this release.
 xxxxx@xxxxx  1998-08-17

I am combining this request with that of allowing the printing custom tags
through a tag listener, as suggested at Javadoc BOF at JavaOne '99.
 xxxxx@xxxxx  1999-09-21

I am reassigning to  xxxxx@xxxxx  because this does not require any tool or
API support.

 xxxxx@xxxxx  2001-02-27

Request #1, emitting a warning for misspellings, is something Jamie can do
now that he has implemented custom tags (which was request #2).
 xxxxx@xxxxx  2001-06-28

This RFE has been implemented.  Location of fix:

CustomTagFactory.java
AbstractSubWriter.java
ConstructorSubWriter.java
HtmlStandardWriter.java
MethodSubWriter.java
standard.properties

 xxxxx@xxxxx  2001-07-06
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang