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: 4502589
Votes 0
Synopsis Doclet API: misleading documentation for "kind" in com.sun.javadoc.Doc
Category doclet:tbd
Reported Against 1.2.2
Release Fixed 1.4.2(mantis)
State 10-Fix Delivered, bug
Priority: 4-Low
Related Bugs
Submit Date 13-SEP-2001
Description
Fixed as suggested.
No regression test included because this is a doc comment only change.

 xxxxx@xxxxx  2002-09-28

java version "1.3.0"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.3.0-C)
Java HotSpot(TM) Client VM (build 1.3.0-C, mixed mode)


There is a specific documentation bug in the documentation for
com.sun.javadoc.Doc.inlineTags() and com.sun.javadoc.Doc.firstSentenceTags().

Doc comment for both methods says:
"...Inline tags are represented as a SeeTag of kind "link"..."

Firstly, the term "kind" is undefined -- assuming it is the
com.sun.javadoc.Tag.kind() method.

Assuming that the term "kind" refers to the Tag.kind() method metioned above:
The comment is then incorrect. A SeeTag representing an inline {@link ...} tag
has kind() equal to "@see", just like your average SeeTag does.
The method that is meant by this cryptic doc comment is, I believe, Tag.name().
This returns "@see" for a SeeTag representing a '@see' doc comment, and
returns "@link" for a SeeTag representing a '{@link ...}' doc comment.

Even by correcting the term "kind" to "Tag.name()", the comment would be
incorrect, because the return value of both Tag.kind() and Tag.name() contains
the '@' symbol, although the comment above implies the opposite, namely that
the '@' symbol is omitted!
(Review ID: 131811) 
======================================================================
Work Around




Write a few toy doclets. Play around until it sits straight in your head.
======================================================================
Evaluation
Changed synopsis from:
  Specific documentation bug in com.sun.javadoc.Doc

  Doclet API: misleading documentation for com.sun.javadoc.Doc
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang