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

Javadoc style issues in the foreign API

    XMLWordPrintable

Details

    • Enhancement
    • Resolution: Fixed
    • P3
    • 22
    • 22
    • core-libs

    Description

      A review of the foreign API javadoc has revealed the following stylistic issues:

      * presence of blank javadoc lines (<p> should be used instead)
      * Javadoc needs another pass of reformatting (line length, indent @params, @throws, ...)
      * inconsistent use of “Client” vs. “User” wording
      * Make sure all javadoc snippets are correct and compile; maybe turn them to standalone snippets?

      Attachments

        There are no Sub-Tasks for this issue.

        Activity

          People

            pminborg Per-Ake Minborg
            mcimadamore Maurizio Cimadamore
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: