RFR [9] 8079342: some docs cleanup for CORBA - part 2

[alexander stepanov]

 > _variableName in the public  javadocs

Please see
http://cr.openjdk.java.net/~avstepan/8079342/webrev.00/src/java.corba/share/classes/com/sun/corba/se/impl/io/ValueHandlerImpl.java.udiff.html
(please update the page as I didn't prepare a new webrev). Hopefully 
that do not harm the code...

Thanks,
Alexander

On 05.05.2015 18:46, Lance Andersen wrote:
> Hi Alexander,
>
> Thank you,  I guess I am not a fan of _variableName in the public 
>  javadocs as it is not something we normally see.
>
> Understand less is more, especially with CORBA.
>
> On May 5, 2015, at 11:41 AM, alexander stepanov 
> <alexander.v.stepanov at oracle.com 
> <mailto:alexander.v.stepanov at oracle.com>> wrote:
>
>> Hello Lance,
>>
>> It just seemed to be less hazardous. E.g., method 'readValue' (in 
>> ValueHandlerImpl) contains inner variable 'in' and parameter '_in' 
>> being documented (also, '_sender' - 'sender').
>>
>> But of course the names could be swapped, if desired. I lazily 
>> preferred not to touch the code (just in case...).
>>
>> Regards,
>> Alexander
>>
>>
>> On 05.05.2015 18:25, Lance Andersen wrote:
>>> Hi Alexander,
>>>
>>> I just started to look at this and have a question:
>>>
>>>
>>> /**
>>>       * Writes the value to the stream using java semantics.
>>> -     * @param out The stream to write the value to
>>> +     * @param _out The stream to write the value to
>>>       * @param value The value to be written to the stream
>>>       **/
>>>      public void writeValue(org.omg.CORBA.portable.OutputStream _out,
>>>
>>>
>>> Is there a reason that you did not change the parameter name to 
>>> "out" vs changing the @param tag to "_out" ?
>>>
>>> Best,
>>> lance
>>>
>>>
>>> On May 5, 2015, at 11:21 AM, alexander stepanov 
>>> <alexander.v.stepanov at oracle.com 
>>> <mailto:alexander.v.stepanov at oracle.com> 
>>> <mailto:alexander.v.stepanov at oracle.com>> wrote:
>>>
>>>> Hello,
>>>>
>>>> Could you please review the following fix
>>>> http://cr.openjdk.java.net/~avstepan/8079342/webrev.00/ 
>>>> <http://cr.openjdk.java.net/%7Eavstepan/8079342/webrev.00/> 
>>>> <http://cr.openjdk.java.net/%7Eavstepan/8079342/webrev.00/>
>>>> for
>>>> https://bugs.openjdk.java.net/browse/JDK-8079342
>>>>
>>>> Just some HTML markup fix for CORBA.
>>>>
>>>> Thanks,
>>>> Alexander
>>>
>>> <http://oracle.com/us/design/oracle-email-sig-198324.gif>
>>> <http://oracle.com/us/design/oracle-email-sig-198324.gif><http://oracle.com/us/design/oracle-email-sig-198324.gif>
>>> <http://oracle.com/us/design/oracle-email-sig-198324.gif>Lance 
>>> Andersen| Principal Member of Technical Staff | +1.781.442.2037
>>> Oracle Java Engineering
>>> 1 Network Drive
>>> Burlington, MA 01803
>>> Lance.Andersen at oracle.com <mailto:Lance.Andersen at oracle.com> 
>>> <mailto:Lance.Andersen at oracle.com>
>>>
>>>
>>>
>>
>
> <http://oracle.com/us/design/oracle-email-sig-198324.gif>
> <http://oracle.com/us/design/oracle-email-sig-198324.gif><http://oracle.com/us/design/oracle-email-sig-198324.gif>
> <http://oracle.com/us/design/oracle-email-sig-198324.gif>Lance 
> Andersen| Principal Member of Technical Staff | +1.781.442.2037
> Oracle Java Engineering
> 1 Network Drive
> Burlington, MA 01803
> Lance.Andersen at oracle.com <mailto:Lance.Andersen at oracle.com>
>
>
>