Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-4502589

Doclet API: misleading documentation for "kind" in com.sun.javadoc.Doc

XMLWordPrintable

    • mantis
    • generic
    • generic

      Name: bsT130419 Date: 09/13/2001

      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)
      ======================================================================

            dkramersunw Douglas Kramer (Inactive)
            bstrathesunw Bill Strathearn (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: