[threeten-dev] Review of javadoc updates

[Roger Riggs]

Hi,

On 03/05/2013 09:02 AM, Stephen Colebourne wrote:
> I don't like the » as it makes it a lot harder to read as source
> code (which is more common than reading HTML). Is there an alternative
> arrow like symbol we could use, such a => or just a colon?
The unbalanced ">" is flagged as an error, so something else is needed.
I replaced the delimiter with "--";  the lines in Duration include the 
phrase "parses as"
that can act as a delimiter.
>
> This phrase reads badly
> "Pattern letter 'u' is the proleptic year which is the same as the
> CLDR definition extended year, instead the SimpleDateFormat definition
> for numeric day of week."
Reworded to remove the reference to CLDR, its unneeded.

We may want to separately describe differences the relationship to CLDR.
>
> In the example table for the public constants, it would be good to
> have two examples when there is a choice:
> ISO_DATE ... '2011-12-03'; '2011-12-03+01:00'
Added  examples.

Thanks, Roger
>
> The description of the pattern letters needs more work to match
> SimpleDateFormat (and that in builder altering to match letters to
> methods), but that is a separate change.
>
> thanks
> Stephen
>
>
> On 2 March 2013 16:48, roger riggs <roger.riggs at oracle.com> wrote:
>> Hi,
>>
>> This javadoc-only change raises the visiblity and enhances the
>> descriptions of the DateTimeFormatter patterns and fixes a number
>> of complaints that the javadoc tool has about the html markup.
>>
>>      https://github.com/ThreeTen/threeten/issues/240
>>
>> webrev: http://cr.openjdk.java.net/~rriggs/webrev-pattern-javadoc-240/
>>
>> javadoc: http://cr.openjdk.java.net/~rriggs/javadoc-pattern-javadoc-240/
>>
>> --
>> Thanks, Roger
>>
>> Oracle Java Platform Group
>>
>> Green Oracle <http://www.oracle.com/commitment> Oracle is committed to
>> developing practices and products that help protect the environment
>>