[prev in list] [next in list] [prev in thread] [next in thread] 

List:       openjdk-awt-dev
Subject:    <AWT Dev> [12] Review Request: 8214823 Javadoc cleanup of java.awt.desktop package
From:       Sergey Bylokhov <Sergey.Bylokhov () oracle ! com>
Date:       2018-12-05 0:42:44
Message-ID: 929ad896-0e32-5031-2ae8-baf481eceb3f () oracle ! com
[Download RAW message or body]

Hello.
Please review a javadoc "weekend cleanup" in jdk 12.

Bug: https://bugs.openjdk.java.net/browse/JDK-8214823
Webrev: http://cr.openjdk.java.net/~serb/8214823/webrev.00

Description of the changes:
  - 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
  - @param, @throws, @return should be aligned, to be more readable
  - some text can be rephrased

Also in a few places the "final" keyword was removed from the parameters
of methods in the interfaces, because it does not make any sense.


-- 
Best regards, Sergey.
[prev in list] [next in list] [prev in thread] [next in thread]