RFR: 8178457: Remove link to 2D guide from Line2D javadoc

classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

RFR: 8178457: Remove link to 2D guide from Line2D javadoc

Philip Race
A small javadoc change to link to a different more stable source
of information on the Java 2D coord. system.

Bug : https://bugs.openjdk.java.net/browse/JDK-8178457

Patch:
--- a/src/java.desktop/share/classes/java/awt/geom/Line2D.java
+++ b/src/java.desktop/share/classes/java/awt/geom/Line2D.java
@@ -35,8 +35,7 @@
   * default coordinate system called <i>user space</i> in which the y-axis
   * values increase downward and x-axis values increase to the right.  For
   * more information on the user space coordinate system, see the
- * <a href="{@docRoot}/../technotes/guides/2d/spec/j2d-intro.html">
- * Coordinate Systems</a> section of the Java 2D Programmer's Guide.
+ * {@link java.awt.Graphics2D} class documentation.
   * <p>
   * This class is only the abstract superclass for all objects that
   * store a 2D line segment.

-phil.
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: RFR: 8178457: Remove link to 2D guide from Line2D javadoc

Jim Graham-5
It's silly to include this statement in Line2D when no other geometry class bothers to mention this.  It is considered
assumed information if you've gotten far enough to be looking at this class.  I would prefer to copy boiler plate from
one of the other Foo2D geometry classes instead...

                        ...jim

On 4/11/17 10:43 AM, Phil Race wrote:

> A small javadoc change to link to a different more stable source
> of information on the Java 2D coord. system.
>
> Bug : https://bugs.openjdk.java.net/browse/JDK-8178457
>
> Patch:
> --- a/src/java.desktop/share/classes/java/awt/geom/Line2D.java
> +++ b/src/java.desktop/share/classes/java/awt/geom/Line2D.java
> @@ -35,8 +35,7 @@
>   * default coordinate system called <i>user space</i> in which the y-axis
>   * values increase downward and x-axis values increase to the right.  For
>   * more information on the user space coordinate system, see the
> - * <a href="{@docRoot}/../technotes/guides/2d/spec/j2d-intro.html">
> - * Coordinate Systems</a> section of the Java 2D Programmer's Guide.
> + * {@link java.awt.Graphics2D} class documentation.
>   * <p>
>   * This class is only the abstract superclass for all objects that
>   * store a 2D line segment.
>
> -phil.
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: RFR: 8178457: Remove link to 2D guide from Line2D javadoc

Philip Race
The boilerplate for all the other classes would be to completely remove
the entire sentence being modified. No mention of coordinate system at all.

I can do that  ... if it is what you meant.

-phil.


On 4/11/17, 3:01 PM, Jim Graham wrote:

> It's silly to include this statement in Line2D when no other geometry
> class bothers to mention this.  It is considered assumed information
> if you've gotten far enough to be looking at this class.  I would
> prefer to copy boiler plate from one of the other Foo2D geometry
> classes instead...
>
>             ...jim
>
> On 4/11/17 10:43 AM, Phil Race wrote:
>> A small javadoc change to link to a different more stable source
>> of information on the Java 2D coord. system.
>>
>> Bug : https://bugs.openjdk.java.net/browse/JDK-8178457
>>
>> Patch:
>> --- a/src/java.desktop/share/classes/java/awt/geom/Line2D.java
>> +++ b/src/java.desktop/share/classes/java/awt/geom/Line2D.java
>> @@ -35,8 +35,7 @@
>>   * default coordinate system called <i>user space</i> in which the
>> y-axis
>>   * values increase downward and x-axis values increase to the
>> right.  For
>>   * more information on the user space coordinate system, see the
>> - * <a href="{@docRoot}/../technotes/guides/2d/spec/j2d-intro.html">
>> - * Coordinate Systems</a> section of the Java 2D Programmer's Guide.
>> + * {@link java.awt.Graphics2D} class documentation.
>>   * <p>
>>   * This class is only the abstract superclass for all objects that
>>   * store a 2D line segment.
>>
>> -phil.
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: RFR: 8178457: Remove link to 2D guide from Line2D javadoc

Philip Race

i.e, this change instead :

--- a/src/java.desktop/share/classes/java/awt/geom/Line2D.java
+++ b/src/java.desktop/share/classes/java/awt/geom/Line2D.java
@@ -31,12 +31,7 @@

  /**
   * This {@code Line2D} represents a line segment in {@code (x,y)}
- * coordinate space.  This class, like all of the Java 2D API, uses a
- * default coordinate system called <i>user space</i> in which the y-axis
- * values increase downward and x-axis values increase to the right.  For
- * more information on the user space coordinate system, see the
- * <a href="{@docRoot}/../technotes/guides/2d/spec/j2d-intro.html">
- * Coordinate Systems</a> section of the Java 2D Programmer's Guide.
+ * coordinate space.
   * <p>
   * This class is only the abstract superclass for all objects that
   * store a 2D line segment.

-phil.

On 04/11/2017 03:34 PM, Philip Race wrote:

> The boilerplate for all the other classes would be to completely remove
> the entire sentence being modified. No mention of coordinate system at
> all.
>
> I can do that  ... if it is what you meant.
>
> -phil.
>
>
> On 4/11/17, 3:01 PM, Jim Graham wrote:
>> It's silly to include this statement in Line2D when no other geometry
>> class bothers to mention this.  It is considered assumed information
>> if you've gotten far enough to be looking at this class.  I would
>> prefer to copy boiler plate from one of the other Foo2D geometry
>> classes instead...
>>
>>             ...jim
>>
>> On 4/11/17 10:43 AM, Phil Race wrote:
>>> A small javadoc change to link to a different more stable source
>>> of information on the Java 2D coord. system.
>>>
>>> Bug : https://bugs.openjdk.java.net/browse/JDK-8178457
>>>
>>> Patch:
>>> --- a/src/java.desktop/share/classes/java/awt/geom/Line2D.java
>>> +++ b/src/java.desktop/share/classes/java/awt/geom/Line2D.java
>>> @@ -35,8 +35,7 @@
>>>   * default coordinate system called <i>user space</i> in which the
>>> y-axis
>>>   * values increase downward and x-axis values increase to the
>>> right.  For
>>>   * more information on the user space coordinate system, see the
>>> - * <a href="{@docRoot}/../technotes/guides/2d/spec/j2d-intro.html">
>>> - * Coordinate Systems</a> section of the Java 2D Programmer's Guide.
>>> + * {@link java.awt.Graphics2D} class documentation.
>>>   * <p>
>>>   * This class is only the abstract superclass for all objects that
>>>   * store a 2D line segment.
>>>
>>> -phil.

Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: RFR: 8178457: Remove link to 2D guide from Line2D javadoc

Jim Graham-5
That seems fine...

                        ...jim

On 4/12/17 12:42 PM, Phil Race wrote:

>
> i.e, this change instead :
>
> --- a/src/java.desktop/share/classes/java/awt/geom/Line2D.java
> +++ b/src/java.desktop/share/classes/java/awt/geom/Line2D.java
> @@ -31,12 +31,7 @@
>
>  /**
>   * This {@code Line2D} represents a line segment in {@code (x,y)}
> - * coordinate space.  This class, like all of the Java 2D API, uses a
> - * default coordinate system called <i>user space</i> in which the y-axis
> - * values increase downward and x-axis values increase to the right.  For
> - * more information on the user space coordinate system, see the
> - * <a href="{@docRoot}/../technotes/guides/2d/spec/j2d-intro.html">
> - * Coordinate Systems</a> section of the Java 2D Programmer's Guide.
> + * coordinate space.
>   * <p>
>   * This class is only the abstract superclass for all objects that
>   * store a 2D line segment.
>
> -phil.
>
> On 04/11/2017 03:34 PM, Philip Race wrote:
>> The boilerplate for all the other classes would be to completely remove
>> the entire sentence being modified. No mention of coordinate system at all.
>>
>> I can do that  ... if it is what you meant.
>>
>> -phil.
>>
>>
>> On 4/11/17, 3:01 PM, Jim Graham wrote:
>>> It's silly to include this statement in Line2D when no other geometry class bothers to mention this.  It is
>>> considered assumed information if you've gotten far enough to be looking at this class.  I would prefer to copy
>>> boiler plate from one of the other Foo2D geometry classes instead...
>>>
>>>             ...jim
>>>
>>> On 4/11/17 10:43 AM, Phil Race wrote:
>>>> A small javadoc change to link to a different more stable source
>>>> of information on the Java 2D coord. system.
>>>>
>>>> Bug : https://bugs.openjdk.java.net/browse/JDK-8178457
>>>>
>>>> Patch:
>>>> --- a/src/java.desktop/share/classes/java/awt/geom/Line2D.java
>>>> +++ b/src/java.desktop/share/classes/java/awt/geom/Line2D.java
>>>> @@ -35,8 +35,7 @@
>>>>   * default coordinate system called <i>user space</i> in which the y-axis
>>>>   * values increase downward and x-axis values increase to the right.  For
>>>>   * more information on the user space coordinate system, see the
>>>> - * <a href="{@docRoot}/../technotes/guides/2d/spec/j2d-intro.html">
>>>> - * Coordinate Systems</a> section of the Java 2D Programmer's Guide.
>>>> + * {@link java.awt.Graphics2D} class documentation.
>>>>   * <p>
>>>>   * This class is only the abstract superclass for all objects that
>>>>   * store a 2D line segment.
>>>>
>>>> -phil.
>
Loading...