RFR (JAXP): 8021787: javax.xml.datatype.XMLGregorianCalendar.getMonth() return is documented wrong

Roger Riggs Roger.Riggs at Oracle.com
Thu Jul 21 13:10:55 UTC 2016


Hi Svenlana,

Line 515: For consistency within the class, the first sentence should 
start 'Return', the rest of the methods use 'Return'.

Line 520: in @return the "Returns" should be removed. And capitialize "The".

Thanks, Roger

On 7/21/2016 8:14 AM, Svetlana Nikandrova wrote:
> Kindly reminder.
>
> On 19.07.2016 16:26, Svetlana Nikandrova wrote:
>> Hi Joe,
>>
>> thank you for your review. As I'm new to javadoc writing feel free to 
>> add any comments.
>> Please see updated webrev:
>> http://cr.openjdk.java.net/~snikandrova/8021787/webrev.01/ 
>> <http://cr.openjdk.java.net/%7Esnikandrova/8021787/webrev.01/>
>>
>> Thank you,
>> Svetlana
>>
>> On 18.07.2016 20:34, huizhe wang wrote:
>>> Hi Svetlana,
>>>
>>> Thanks for working on these bugs. The change is correct. It would be 
>>> better to say: "Returns the month of this calendar", in both the 
>>> returns tag and the description (not number of month).
>>>
>>> While we are in this class, it would be good to at least fix the 
>>> missing @returns tags in a number of methods, e.g. getDay, 
>>> getTimezone, getHour, getMinute, toGregorianCalendar. Also, it 
>>> @Override equals, hashCode, toString, and clone.
>>>
>>> Thanks,
>>>
>>> Joe
>>>
>>> On 7/18/2016 8:49 AM, Svetlana Nikandrova wrote:
>>>> Hello all,
>>>>
>>>> please review this javadoc fix for 
>>>> javax.xml.datatype.XMLGregorianCalendar.getMonth()
>>>> Webrev:
>>>> http://cr.openjdk.java.net/~snikandrova/8021787/webrev.00/ 
>>>> <http://cr.openjdk.java.net/%7Esnikandrova/8021787/webrev.00/>
>>>> JBS:
>>>> https://bugs.openjdk.java.net/browse/JDK-8021787
>>>>
>>>> Thank you,
>>>> Svetlana
>>>
>>
>



More information about the core-libs-dev mailing list