<AWT Dev> [9] Review request for 8043967: Fix doclint warnings for java.awt
alexander stepanov
alexander.v.stepanov at oracle.com
Tue Jun 24 08:03:12 UTC 2014
Thanks!
On 23.06.2014 21:13, Petr Pchelko wrote:
> Looks good.
>
> With best regards. Petr.
>
>> On Jun 23, 2014, at 7:47 PM, alexander stepanov <alexander.v.stepanov at oracle.com> wrote:
>>
>> Hello Petr,
>>
>>> AWTKeyStroke why do you use a full name in @throws?
>> In case of short name the following error occurs:
>>
>> /home/user/hd2/doclint/current/src/jdk/src/share/classes/java/awt/AWTKeyStroke.java:805: error: reference not found
>> * @throws ObjectStreamException if a serialization problem occurs
>> ^
>> /home/user/hd2/doclint/current/src/jdk/src/share/classes/java/awt/AWTKeyStroke.java:807: warning: no @throws for java.io.ObjectStreamException
>> protected Object readResolve() throws java.io.ObjectStreamException {
>> ^
>>
>> So it seems that javadoc is happy here only if the full exception name is used. It doesn't affect the resulting html.
>>
>> The other notes were fixed, thanks:
>> http://cr.openjdk.java.net/~avstepan/8043967/webrev.02/
>>
>> Regards,
>> Alexander
>>
>>
>> On 23.06.2014 16:58, Petr Pchelko wrote:
>>> Hello, Alexander.
>>>
>>> A couple of comments:
>>>
>>> AWTKeyStroke why do you use a full name in @throws?
>>> HeadlessException.getMessage you could use @inheritDoc here.
>>> KeyboardFocusManager: 1463 Why did you add an extra line here?
>>> Robot: 513 - the line is not aligned
>>>
>>> With best regards. Petr.
>>>
>>> On 23 июня 2014 г., at 13:35, alexander stepanov <alexander.v.stepanov at oracle.com> wrote:
>>>
>>>> Sorry, just a reminder.
>>>>> On 03.06.2014 20:46, alexander stepanov wrote:
>>>>>> Hello Sergey,
>>>>>>
>>>>>> Updated; please see
>>>>>> http://cr.openjdk.java.net/~avstepan/8043967/webrev.01/
>>>>>>
>>>>>> Thanks,
>>>>>> Alexander
>>>>>>
>>>>>> On 03.06.2014 17:56, Sergey Bylokhov wrote:
>>>>>>> Hi, Alexander.
>>>>>>> A few notes:
>>>>>>> - Use two spaces after @param tag only. in other cases use one space.
>>>>>>> - Do no align names of the @params tag like this:
>>>>>>> 390 * position will not be replaced).
>>>>>>> 391 * @param str the non-{@code null} text to use as
>>>>>>> 392 * the replacement
>>>>>>> 393 * @param start the start position
>>>>>>> 394 * @param end the end position
>>>>>>> 395 * @deprecated As of JDK version 1.1,
>>>>>>> Change them to:
>>>>>>> 390 * position will not be replaced).
>>>>>>> 391 * @param str the non-{@code null} text to use as
>>>>>>> 392 * the replacement
>>>>>>> 393 * @param start the start position
>>>>>>> 394 * @param end the end position
>>>>>>> 395 * @deprecated As of JDK version 1.1,
>>>>>>> - Add empty line after method description before @param tag.
>>>>>>> - Description of the method should ends by dot.
>>>>>>>
>>>>>>> On 6/3/14 4:48 PM, alexander stepanov wrote:
>>>>>>>> Hello,
>>>>>>>>
>>>>>>>> Could you please review the fix for the following bug:
>>>>>>>> https://bugs.openjdk.java.net/browse/JDK-8043967
>>>>>>>>
>>>>>>>> Webrev:
>>>>>>>> http://cr.openjdk.java.net/~avstepan/8043967
>>>>>>>>
>>>>>>>> Just a cleanup of javadoc to avoid doclint warnings.
>>>>>>>>
>>>>>>>> Thanks,
>>>>>>>> Alexander
>>>>>>> --
>>>>>>> Best regards, Sergey.
More information about the awt-dev
mailing list