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

Javadoc cleanup of javax.sound.sampled package

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: P4
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 9
    • Component/s: client-libs
    • Labels:
    • Subcomponent:
    • Resolved In Build:
      b22
    • CPU:
      generic
    • OS:
      generic

      Description

       - @param, @return should not end with a dot, except a case when more than one sentences are used.
       - Description of the class/method/field should be followed by dot.
       - Incorrect links or typos should be fixed (ex http://cr.openjdk.java.net/~serb/8043979/specdiff/FloatControl-report.html#method:getMaxLabel())

      The full specdiff: http://cr.openjdk.java.net/~serb/8043979/specdiff/package-summary.html

       - some broken merges from 1999(!!!) were fixed(ex http://cr.openjdk.java.net/~serb/8043979/webrev.00/src/share/classes/javax/sound/sampled/LineListener.java.udiff.html)
       - 80 column limit.
       - empty line after description/before the first tag.
       - sets of spaces in the middle of text were deleted.
       - @param, @throws, @return now align, to be more readable.
       - <tag> should be replaced by {@tag }.
       - unnecessary imports should be removed.
       - @see tags can be simplified in some places.
       - unnecessary spaces and lines can be removed.
       - @Override should be added when necessary.

      Webrev can be found at: http://cr.openjdk.java.net/~serb/8043979/webrev.00

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                serb Sergey Bylokhov
                Reporter:
                serb Sergey Bylokhov
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: