commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Benedikt Ritter <b...@systemoutprintln.de>
Subject Re: [lang] Please fix DateParser Javadocs
Date Wed, 29 Feb 2012 18:27:01 GMT
I just read the thread from commits@c.a.org. Please ignore my last post.

Am 29.02.2012 19:25, schrieb Benedikt Ritter:
> Am 29.02.2012 17:54, schrieb sebb:
>> On 29 February 2012 16:11, Benedikt Ritter<bene@systemoutprintln.de>
>> wrote:
>>> Am 29.02.2012 15:28, schrieb Gary Gregory:
>>>
>>>> Can someone please fix:
>>>>
>>>> [WARNING]
>>>>
>>>> C:\svn\org\apache\commons\trunks-proper\lang\src\main\java\org\apache\commons\lang3\time\DateParser.java:75:
>>>>
>>>> warning - Tag @link: can't find getTimeZo
>>>> neOverridesCalendar() in org.apache.commons.lang3.time.DateParser
>>>
>>>
>>> The problem is, that there is no method with name
>>> "getTimeZoneOverridesCalendar()" in DateParser, so that link can't be
>>> resolved (I think you already knew that :).
>>> I suppose the comment is meant to refer to getTimeZone() in
>>> java.util.Calendar.
>>
>> I don't think that's correct.
>>
>> The Javadoc originally said:
>>
>> *<p>This zone is always used for<code>Date</code> formatting.
>> * If a<code>Calendar</code> is passed in to be formatted, the
>> * time zone on that may be used depending on
>> * {@link #getTimeZoneOverridesCalendar()}.</p>
>>
>> To me, this implies that there was/is a method called something like
>>
>> getTimeZoneOverridesCalendar()
>>
>> which was/is used to determine whether or not to use the timezone from
>> the provided calendar.
>
> You're right, maybe we have been a bit rash with fixing that. I've
> looked into the SVN log and there is no hint to where that comment was
> coming from. The interface was introduced in r1236055 with that comment.
> I've also looked into the corresponding issue LANG-462, but there is no
> clue as well.
> Maybe Henri Yandell can give some hints, because he was involved in the
> discussion about that issue.
>
>>
>> Date.getTimeZone() just happens to be a similar method name; I don't
>> see how it's relevant here.
>
> As I said, Calendar.getTimeZone() was just my guess (because it said
> "OverridesCalendar").
>
>>
>> The way to find out is to check what the code actually does (did).
>
> since DateParser is just an interface, there is no code to check ;-) So,
> what do we do now?
>
> Regards,
> Benedikt
>
>>
>>> If so, you can fix that by changing the link to: {@link
>>> java.util.Calendar#getTimeZone()}
>>>
>>> Regards,
>>> Benedikt
>>>
>>>
>>>>
>>>> It's not obvious to me what the right fix is.
>>>>
>>>> Thank you,
>>>>
>>>
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>>> For additional commands, e-mail: dev-help@commons.apache.org
>>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>> For additional commands, e-mail: dev-help@commons.apache.org
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message