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

DocCheck: Request for warning when @param tag has no text.

    XMLWordPrintable

    Details

    • Type: Enhancement
    • Status: Closed
    • Priority: P4
    • Resolution: Fixed
    • Affects Version/s: 1.1.3
    • Fix Version/s: 1.2.0
    • Component/s: tools
    • Subcomponent:
    • Resolved In Build:
      1.2fcs
    • CPU:
      sparc
    • OS:
      solaris_2.5.1
    • Verification:
      Not verified

      Description

      When the @param tag in a doc comment has a variable but no textual description,
      nothing pertaining to the parameter shows up in the html file, but the user
      is not given a warning. For example, if the following appeared in a doc comment,
           @param x
      no warning would be given to the user, yet nothing pertaining the parameter x
      would appear in the html file.

      The @exception tag will give the user a warning in similar sitations in which
      it has no text. For example, the tag
           @exception GenericException
      will give the user a warning that there's no text accompanying the @exception
      tag.

      A similar warning for the @param tag would be useful.

        Attachments

          Activity

            People

            Assignee:
            earmstrosunw Eric Armstrong (Inactive)
            Reporter:
            asommere Alan Sommerer (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: