On Wed, 17 Feb 2021 15:08:58 GMT, Prasanta Sadhukhan <[email protected]>
wrote:
>> The API doc for Graphics2D.clip(shape s) claims that passing a null argument
>> would actually clear the existing clipping area, which is incorrect.
>> This statement is applicable only to G2D.setClip() and not for the clip()
>> method. G2D.clip() would throw a NullPointerException when it encounters a
>> null argument.
>> Updated spec to rectify this.
>
> Prasanta Sadhukhan has updated the pull request incrementally with one
> additional commit since the last revision:
>
> javadoc change
src/java.desktop/share/classes/java/awt/Graphics2D.java line 1206:
> 1204: * with the current clip, it will throw {@code NullPointerException}
> 1205: * for a null shape unless the user clip is also {@code null}.
> 1206: * So calling this method with a null argument is not recommended.
Suggestion:
* for a {@code null} shape unless the user clip is also {@code null}.
* So calling this method with a {@code null} argument is not recommended.
src/java.desktop/share/classes/java/awt/Graphics2D.java line 1206:
> 1204: * with the current clip, it will throw {@code NullPointerException}
> 1205: * for a null shape unless the user clip is also {@code null}.
> 1206: * So calling this method with a null argument is not recommended.
Since you're editing the javadoc for this method, wouldn't adding a couple
`<p>` break up the description to make it clearer?
1198 * <p>The <i>user clip</i> modified by this method is independent of the
1203 * user clip.
* <p>Since this method intersects the specified shape
The rendered javadoc will have clear separation between different paragraphs
and will facilitate scanning the method description.
Does it make any sense?
-------------
PR: https://git.openjdk.java.net/jdk/pull/2476
