<AWT Dev> [8] Review request for 8003965: Toolkit.beep() documentation is ambiguous

Anthony Petrov anthony.petrov at oracle.com
Mon Sep 9 06:18:31 PDT 2013


Looks OK to me. Please get a CCC approval before pushing this fix.

--
best regards,
Anthony

On 09/02/2013 05:18 PM, Oleg Pekhovskiy wrote:
> Hi Team,
>
> please review the second version of fix here:
> http://cr.openjdk.java.net/~bagiras/8003965.2/
>
> Thanks,
> Oleg
>
>
> On 29.08.2013 16:05, Anthony Petrov wrote:
>> Note that this change will also need a CCC request filed/approved before
>> the fix may be pushed.
>>
>> --
>> best regards,
>> Anthony
>>
>> On 08/29/13 16:03, Anthony Petrov wrote:
>>> Hi Oleg,
>>>
>>> I believe that a javadoc shouldn't mention any particular native APIs
>>> used to implement a particular functionality, because:
>>>
>>> 1. There are many more platforms where Java runs, and they also may
>>> implement the beep() method.
>>>
>>> 2. In the future we may need to change the underlying implementation,
>>> and we certainly don't want to also change the javadoc to describe the
>>> low-level changes.
>>>
>>> Hence, I suggest to only state something like the following:
>>>
>>> "Tells the native system to emit a beep. Emitting depends on system
>>> settings and hardware capabilities."
>>>
>>> --
>>> best regards,
>>> Anthony
>>>
>>> On 08/29/13 14:52, Oleg Pekhovskiy wrote:
>>>> Hi all,
>>>>
>>>> please review the fix for JDK-8003965 (not available on bugs.sun.com):
>>>> http://cr.openjdk.java.net/~bagiras/8003965.1/
>>>>
>>>> It's just a Javadoc fix.
>>>>
>>>> Thanks,
>>>> Oleg


More information about the awt-dev mailing list