Details

    • Type: Task
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.5
    • Component/s: build
    • Labels:

      Description

      Creating this jira to find and fix the javadoc warnings and errors.

      With JDK 8, we are unable to get Javadoc unless your tool meets the standards of doclint.

      Some of its rules are:


      no self-closed HTML tags, such as <br /> or <a id="x" />
      no unclosed HTML tags, such as <ul> without matching </ul>
      no invalid HTML end tags, such as </br>
      no invalid HTML attributes, based on doclint's interpretation of W3C HTML 4.01
      no duplicate HTML id attribute
      no empty HTML href attribute
      no incorrectly nested headers, such as class documentation must have <h3>, not <h4>
      no invalid HTML tags, such as List<String> (where you forgot to escape using &lt;)
      no broken @link references
      no broken @param references, they must match the actual parameter name
      no broken @throws references, the first word must be a class name
      

      We don't get any output if it breaks any of the above rule. It throws errors.

      We can turn off doclint by configuring the following propery for javadoc plugin

      <additionalparam>-Xdoclint:none</additionalparam>

        Attachments

        1. rb39419.patch
          9 kB
          Amareshwari Sriramadasu

          Issue Links

            Activity

              People

              • Assignee:
                gliptak Gabor Liptak
                Reporter:
                raju.bairishetti Raju Bairishetti
              • Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: