RFR(s): 8080450: doc for Double/Int/LongSummaryStatistics.toString has errors
Hi all, Please review this small javadoc change to the Double/Int/LongSummaryStatistics classes' toString() method specifications. Basically they all inherit the Object.toString() doc, which is mostly irrelevant, and in two cases the doc comment is placed erroneously and so is entirely ignored. See the bug report for details: https://bugs.openjdk.java.net/browse/JDK-8080450 Webrev: http://cr.openjdk.java.net/~smarks/reviews/8080450/webrev.0/ Javadoc output with changes in place: http://cr.openjdk.java.net/~smarks/reviews/8080450/javadoc.0/java/util/Doubl... http://cr.openjdk.java.net/~smarks/reviews/8080450/javadoc.0/java/util/IntSu... http://cr.openjdk.java.net/~smarks/reviews/8080450/javadoc.0/java/util/LongS... For comparison, here are the JDK 8 versions of the docs: http://docs.oracle.com/javase/8/docs/api/java/util/DoubleSummaryStatistics.h... http://docs.oracle.com/javase/8/docs/api/java/util/IntSummaryStatistics.html... http://docs.oracle.com/javase/8/docs/api/java/util/LongSummaryStatistics.htm... (I expect this will also require a CCC request, since this is formally a change in the specification.) s'marks
Hi Stuart, The changes look good; a ccc is not necessary IMO. Thanks, -Joe On 6/24/2015 1:37 PM, Stuart Marks wrote:
Hi all,
Please review this small javadoc change to the Double/Int/LongSummaryStatistics classes' toString() method specifications. Basically they all inherit the Object.toString() doc, which is mostly irrelevant, and in two cases the doc comment is placed erroneously and so is entirely ignored.
See the bug report for details:
https://bugs.openjdk.java.net/browse/JDK-8080450
Webrev:
http://cr.openjdk.java.net/~smarks/reviews/8080450/webrev.0/
Javadoc output with changes in place:
http://cr.openjdk.java.net/~smarks/reviews/8080450/javadoc.0/java/util/Doubl...
http://cr.openjdk.java.net/~smarks/reviews/8080450/javadoc.0/java/util/IntSu...
http://cr.openjdk.java.net/~smarks/reviews/8080450/javadoc.0/java/util/LongS...
For comparison, here are the JDK 8 versions of the docs:
http://docs.oracle.com/javase/8/docs/api/java/util/DoubleSummaryStatistics.h...
http://docs.oracle.com/javase/8/docs/api/java/util/IntSummaryStatistics.html...
http://docs.oracle.com/javase/8/docs/api/java/util/LongSummaryStatistics.htm...
(I expect this will also require a CCC request, since this is formally a change in the specification.)
s'marks
Joe, great, I'll go ahead and push. Thanks. Lance, thanks for looking as well. s'marks On 6/24/15 1:56 PM, Joseph D. Darcy wrote:
Hi Stuart,
The changes look good; a ccc is not necessary IMO.
Thanks,
-Joe
On 6/24/2015 1:37 PM, Stuart Marks wrote:
Hi all,
Please review this small javadoc change to the Double/Int/LongSummaryStatistics classes' toString() method specifications. Basically they all inherit the Object.toString() doc, which is mostly irrelevant, and in two cases the doc comment is placed erroneously and so is entirely ignored.
See the bug report for details:
https://bugs.openjdk.java.net/browse/JDK-8080450
Webrev:
http://cr.openjdk.java.net/~smarks/reviews/8080450/webrev.0/
Javadoc output with changes in place:
http://cr.openjdk.java.net/~smarks/reviews/8080450/javadoc.0/java/util/Doubl...
http://cr.openjdk.java.net/~smarks/reviews/8080450/javadoc.0/java/util/IntSu...
http://cr.openjdk.java.net/~smarks/reviews/8080450/javadoc.0/java/util/LongS...
For comparison, here are the JDK 8 versions of the docs:
http://docs.oracle.com/javase/8/docs/api/java/util/DoubleSummaryStatistics.h...
http://docs.oracle.com/javase/8/docs/api/java/util/IntSummaryStatistics.html...
http://docs.oracle.com/javase/8/docs/api/java/util/LongSummaryStatistics.htm...
(I expect this will also require a CCC request, since this is formally a change in the specification.)
s'marks
Hi Stuart, Looks fine. seems more of a bug fix so I am not sure a ccc is needed but I am sure Joe will let us know :-) On Jun 24, 2015, at 4:37 PM, Stuart Marks <stuart.marks@oracle.com> wrote:
Hi all,
Please review this small javadoc change to the Double/Int/LongSummaryStatistics classes' toString() method specifications. Basically they all inherit the Object.toString() doc, which is mostly irrelevant, and in two cases the doc comment is placed erroneously and so is entirely ignored.
See the bug report for details:
https://bugs.openjdk.java.net/browse/JDK-8080450
Webrev:
http://cr.openjdk.java.net/~smarks/reviews/8080450/webrev.0/
Javadoc output with changes in place:
http://cr.openjdk.java.net/~smarks/reviews/8080450/javadoc.0/java/util/Doubl... http://cr.openjdk.java.net/~smarks/reviews/8080450/javadoc.0/java/util/IntSu... http://cr.openjdk.java.net/~smarks/reviews/8080450/javadoc.0/java/util/LongS...
For comparison, here are the JDK 8 versions of the docs:
http://docs.oracle.com/javase/8/docs/api/java/util/DoubleSummaryStatistics.h... http://docs.oracle.com/javase/8/docs/api/java/util/IntSummaryStatistics.html... http://docs.oracle.com/javase/8/docs/api/java/util/LongSummaryStatistics.htm...
(I expect this will also require a CCC request, since this is formally a change in the specification.)
s'marks
Lance Andersen| Principal Member of Technical Staff | +1.781.442.2037 Oracle Java Engineering 1 Network Drive Burlington, MA 01803 Lance.Andersen@oracle.com
participants (3)
-
Joseph D. Darcy
-
Lance Andersen
-
Stuart Marks