<i18n dev> RFR: 8278254: Cleanup doclint warnings in java.desktop module [v2]

[Prasanta Sadhukhan]

On Tue, 11 Jan 2022 05:19:56 GMT, Sergey Bylokhov <serb at openjdk.org> wrote:

>> Prasanta Sadhukhan has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   review fix
>
> src/java.desktop/share/classes/java/awt/BufferCapabilities.java line 65:
> 
>> 63: 
>> 64:     /**
>> 65:      * Returns the imaga capabilities of the front buffer
> 
> Please add a dot after the first sentence, it is used as a summary doc for the method.
> Why the text about "displayed" buffer is removed? is it some special "term" like "intermediate" below?

Done

> src/java.desktop/share/classes/java/awt/Component.java line 4697:
> 
>> 4695: 
>> 4696:     /**
>> 4697:      * Checks whether or not paint messages received from the operating system
> 
> In the change above the "Returns whether or not" text is used. It is better to use the same new text, or just use the old one.

Done

> src/java.desktop/share/classes/java/awt/event/KeyEvent.java line 653:
> 
>> 651:     /* For European keyboards */
>> 652:     /**
>> 653:      * Constant for the DEAD_GRAVE function key.
> 
> I do not know, are all the keys here actually "function keys"?

Remove function keyword as it seems dead keys are combination of keys.

> src/java.desktop/share/classes/java/beans/beancontext/BeanContextServicesSupport.java line 150:
> 
>> 148:     /************************************************************************/
>> 149: 
>> 150:     /**
> 
> This will add many statements to the specification which could be verified by the TCK. DO we really want to say all of that? Especially about serialization. Same question for other changes below.

ok. only added relevant info

> src/java.desktop/share/classes/javax/swing/undo/UndoableEditSupport.java line 150:
> 
>> 148: 
>> 149:     /**
>> 150:      * Start UndoableEdit.
> 
> What does it mean? Is it clear enough for the class which "managing <code>UndoableEdit</code> listeners"?

It seems it other places like CompoundEdit class, "assemble little UndoableEdits " statement is used so it seems ok to use UndoableEdit here. At least it's better than (to me)

"DEADLOCK WARNING: Calling this method may call
     * <code>undoableEditHappened</code> in all listeners."

   
 used in endUpdate...

-------------

PR: https://git.openjdk.java.net/jdk/pull/7004