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

Cleanup of javadoc in javax.print package

    XMLWordPrintable

Details

    • 2d
    • b23
    • generic
    • generic

    Description

      The spec of javax.print package can be updated and the next rules can be applied:
       - <tag> should be replaced by {@tag }
       - 80 column limit
       - description of the class/method/field should be followed by dot
       - @param, @return should not end with a dot, except a case when more than one sentences are used
       - empty line after description/before the first tag was added
       - unnecessary empty lines were removed
       - sets of spaces in the middle of text were deleted
       - @param, @throws, @return should be aligned, to be more readable
       - unnecessary imports should be removed
       - the "null"/"true"/"false"/"this" should be wrapped in {@code } when necessary
       - the order of different tags were unified across the package

      In some cases there are no specification for the public API. it should be fixed.

      Attachments

        Issue Links

          csr for

          CSR - null JDK-8186753 Cleanup of javadoc in javax.print package

          • P4 - Minor loss of function, or other problem where easy workaround is present.
          • Closed
          relates to

          Bug - A problem which impairs or prevents the functions of the product. JDK-8050852 Javadoc cleanup of javax.sound.midi package

          • P4 - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. JDK-8180889 Cleanup of javadoc in java.datatransfer module

          • P4 - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. JDK-8181877 Cleanup of javadoc in javax.accessibility package

          • P4 - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. JDK-8211833 Javadoc cleanup of java.applet package

          • P4 - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. JDK-8212790 Javadoc cleanup of java.awt.color package

          • P4 - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. JDK-8214823 Javadoc cleanup of java.awt.desktop package

          • P4 - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Activity

            People

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

              Dates

                Created:
                Updated:
                Resolved: