[errorprone] util.Stats: Add summary fragment to javadoc

Errorprone complains about missing summary in these javadocs.

[MissingSummary] A summary fragment is required; consider using the
value of the @return b lock as a summary fragment instead.

         * @return variance of the added values
           ^
(see https://google.github.io/styleguide/javaguide.html#s7.2-summary-fragment)
  Did you mean '*Returns variance of the added values.'?

Change-Id: I29d633ec95c18b17cc92b069dd1a94fbb2a75c94

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/Stats.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/Stats.java
index d957deb34cb727c8d5cd0a8d05b962d8c5ec1e22..efa6e7ddc3b0c1f8f2d9726a8a3f2fce683b38cb 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/util/Stats.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/Stats.java
@@ -43,14 +43,18 @@ public class Stats {
        }
 
        /**
-        * @return number of the added values
+        * Returns the number of added values
+        *
+        * @return  the number of added values
         */
        public int count() {
                return n;
        }
 
        /**
-        * @return minimum of the added values
+        * Returns the smallest value added
+        *
+        * @return the smallest value added
         */
        public double min() {
                if (n < 1) {
@@ -60,7 +64,9 @@ public class Stats {
        }
 
        /**
-        * @return maximum of the added values
+        * Returns the biggest value added
+        *
+        * @return the biggest value added
         */
        public double max() {
                if (n < 1) {
@@ -70,9 +76,10 @@ public class Stats {
        }
 
        /**
-        * @return average of the added values
+        * Returns the average of the added values
+        *
+        * @return the average of the added values
         */
-
        public double avg() {
                if (n < 1) {
                        return Double.NaN;
@@ -81,7 +88,9 @@ public class Stats {
        }
 
        /**
-        * @return variance of the added values
+        * Returns the variance of the added values
+        *
+        * @return the variance of the added values
         */
        public double var() {
                if (n < 2) {
@@ -91,7 +100,9 @@ public class Stats {
        }
 
        /**
-        * @return standard deviation of the added values
+        * Returns the standard deviation of the added values
+        *
+        * @return the standard deviation of the added values
         */
        public double stddev() {
                return Math.sqrt(this.var());