Review : 6546713: Link optional in Collection exception documentation to explanation

[Doug Lea]

On 04/19/11 21:07, David Holmes wrote:
> Hi Mike,
>
> Mike Duigou said the following on 04/20/11 08:00:
>> Hello All;
>>
>> Another collections javadoc review request. This change links the "(optional)"
>> notes in on various Collection methods to text which explains why they are not
>> thrown by all collections.
>
> Generally looks good. I think you should revert this additional change in
> Collection.java:
>
> ! * @throws NullPointerException if the specified array is {@code null}
>
> "null" is used all over the place without being code font, including other
> @throws NullPointerException.

This, along with literals "true" and "false" are not code-fonted
very consistently. Someday someone should do a big consistency pass
across the whole code base.


>
>> I have not applied the change to java.util.concurrent package javadoc. I will
>> leave the JSR 166 maintainers.
>
> Yeah well ... on behalf of them can I twist your arm? If it isn't done now it
> needs another CR, etc etc. Appears to be 22 cases across 4 classes. Maybe I can
> generate the patch for you ... :)

This is probably easier if we (jsr166) do it, because we have
jsr166->OpenJDK integration paths semi-automated, but not vice versa.

-Doug