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

detect redundant <p> at end of description

    XMLWordPrintable

Details

    • Enhancement
    • Resolution: Unresolved
    • P3
    • None
    • None
    • tools

    Description

      A common fault that keeps reappearing in API doc comments is an empty <p> tag, which eventually shows up as an error in the HTML checks done in DocCheck.

      The typical cause is authors ending a paragraph with <p>, often before a block tag, such as the following

      /**
       * This is a comment for a method.
       * This is more descriptive text.
       * <p>
       * @param i this is an argument
       */

      This is common enough and easy enough to detect in doclint. It's simply a "start element 'p'" followed by no content at the end of a description.

      Attachments

        Activity

          People

            Unassigned Unassigned
            jjg Jonathan Gibbons
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: