<Swing Dev> [8] Review Request: JDK-8025234 [javadoc] fix some errors in javax.swing.**

[Dmitry Ginzburg]

forwarding to swing-dev

14.10.2013 18:27, Dmitry Ginzburg wrote:
> See new webrev: http://cr.openjdk.java.net/~yan/jdk-8025234/webrev.01/ 
> <http://cr.openjdk.java.net/%7Eyan/jdk-8025234/webrev.01/>
>
> Thanks,
> -Dmitry
>
> 04.10.2013 21:22, alexey zhebel wrote:
>> Yes, change <p/> to <p>. Doc comments are not really written in HTML. 
>> They get converted to HTML by Javadoc. The <p> here is not a 
>> paragraph opening tag, it is a marker for Javadoc to start a new 
>> paragraph.
>>
>> Best regards,
>> Alexey Zhebel
>>
>> On 04.10.2013 20:56, Alexander Scherbatiy wrote:
>>>
>>>   The mistaken tag <p/> should be corrected to <p>. This avoids 
>>> fixing the typo next time.
>>>
>>>   Thanks,
>>>   Alexandr.
>>>
>>> On 10/4/2013 5:40 PM, Dmitry Ginzburg wrote:
>>>> Hi guys
>>>>
>>>> Have you decided what to do in this situation?
>>>> Maybe my solution have to be approved?
>>>>
>>>> Thanks,
>>>> -Dmitry
>>>>
>>>> 27.09.2013 20:11, alexey zhebel wrote:
>>>>> Hi Alexander!
>>>>>
>>>>> AFAIK, the paragraph separator for Javadoc comments is <p>. So it 
>>>>> is a typo (the > and / characters are close on the keyboard).
>>>>>
>>>>> Here is a good example:
>>>>> http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#format 
>>>>>
>>>>>
>>>>> Best regards,
>>>>> Alexey Zhebel
>>>>>
>>>>> On 27.09.2013 16:43, Alexander Scherbatiy wrote:
>>>>>>
>>>>>>   Hello Alexey,
>>>>>>
>>>>>>   The is the <p/> tag at line: 1384 in the file 
>>>>>> http://hg.openjdk.java.net/jdk8/awt/jdk/file/ca45169cb4eb/src/share/classes/javax/swing/AbstractButton.java 
>>>>>>
>>>>>>      1379     /**
>>>>>>      1380      * Sets the <code>borderPainted</code> property.
>>>>>>      1381      * If <code>true</code> and the button has a border,
>>>>>>      1382      * the border is painted. The default value for the
>>>>>>      1383      * <code>borderPainted</code> property is 
>>>>>> <code>true</code>.
>>>>>>      1384      * <p/>
>>>>>>      1385      * Some look and feels might not support
>>>>>>      1386      * the <code>borderPainted</code> property,
>>>>>>      1387      * in which case they ignore this.
>>>>>>
>>>>>>  Could look at this and say is it just a typo and what should be 
>>>>>> the corrected code?
>>>>>>
>>>>>>  Thanks,
>>>>>>  Alexandr.
>>>>>>
>>>>>>
>>>>>> On 9/27/2013 2:48 PM, Dmitry Ginzburg wrote:
>>>>>>> According to w3c (http://dev.w3.org/html5/markup/p.html#p) 
>>>>>>> <http://dev.w3.org/html5/markup/p.html#p> pelement’send tagmay 
>>>>>>> be omitted if thepelement is immediately followed by an <set of 
>>>>>>> some tags>, but that's false in our case, it's followed by text.
>>>>>>>
>>>>>>> 27.09.2013 14:38, Sergey Bylokhov wrote:
>>>>>>>> Why not just <p>?
>>>>>>>>
>>>>>>>> On 27.09.2013 14:32, Dmitry Ginzburg wrote:
>>>>>>>>> If it made sense earlier to do the same thing with 
>>>>>>>>> self-closing tag, it's now the same, but valid for doclint.
>>>>>>>>>
>>>>>>>>> 27.09.2013 14:30, Alexander Scherbatiy wrote:
>>>>>>>>>>
>>>>>>>>>> --- old/src/share/classes/javax/swing/AbstractButton.java
>>>>>>>>>> +++ new/src/share/classes/javax/swing/AbstractButton.java
>>>>>>>>>> @@ -1381,7 +1381,7 @@
>>>>>>>>>>       * If <code>true</code> and the button has a border,
>>>>>>>>>>       * the border is painted. The default value for the
>>>>>>>>>>       * <code>borderPainted</code> property is 
>>>>>>>>>> <code>true</code>.
>>>>>>>>>> -     * <p/>
>>>>>>>>>> +     * <p></p>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> Does it has sense to have open and closed p tags without the 
>>>>>>>>>> text?
>>>>>>>>>>
>>>>>>>>>> Otherwise, the fix looks good for me.
>>>>>>>>>>
>>>>>>>>>> Thanks,
>>>>>>>>>> Alexandr.
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> On 9/26/2013 6:20 PM, Dmitry Ginzburg wrote:
>>>>>>>>>>> Hello, Swing Team.
>>>>>>>>>>>
>>>>>>>>>>> Please review the fix for the following issue:
>>>>>>>>>>> https://bugs.openjdk.java.net/browse/JDK-8025234
>>>>>>>>>>> The fix is available at:
>>>>>>>>>>> http://cr.openjdk.java.net/~yan/jdk-8025234/webrev.00/
>>>>>>>>>>>
>>>>>>>>>>> This is the fix for javadoc errors, on which doclint was 
>>>>>>>>>>> showing some issues.
>>>>>>>>>>>
>>>>>>>>>>> The patch contains only simple markup fixes; no 
>>>>>>>>>>> changes/fixes in
>>>>>>>>>>> documentation text; the specification itself wasn't changed.
>>>>>>>>>>>
>>>>>>>>>>> Thanks,
>>>>>>>>>>> -Dmitry 
>>>>>>>>
>>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> -- 
>>>>>>> Dmitry Ginzburg, FXSQE team member
>>>>>>
>>>>>
>>>>
>>>>
>>>
>>
>
>


-- 
Dmitry Ginzburg, FXSQE team member