Fixed license header, added missing javadoc.

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/math/trunk@141326 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/commons/math/stat/univariate/StatisticalSummaryValues.java

@@ -1,19 +1,17 @@
 /*
+ * Copyright 2004 The Apache Software Foundation.
  * 
- * Copyright (c) 2004 The Apache Software Foundation. All rights reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
  * 
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License. You may obtain a copy
- * of the License at
- * 
- * http://www.apache.org/licenses/LICENSE-2.0
+ *      http://www.apache.org/licenses/LICENSE-2.0
  * 
  * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- * License for the specific language governing permissions and limitations
- * under the License.
- *  
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 package org.apache.commons.math.stat.univariate;
 
@@ -22,29 +20,41 @@ import java.io.Serializable;
 /**
  *  Value object representing the results of a univariate statistical summary.
  *
- * @version $Revision: 1.1 $ $Date: 2004/05/18 04:17:29 $
+ * @version $Revision: 1.2 $ $Date: 2004/06/20 01:50:18 $
  */
-public class StatisticalSummaryValues implements Serializable, StatisticalSummary {
+public class StatisticalSummaryValues implements Serializable, 
+    StatisticalSummary {
    
     /** Serialization id */
     static final long serialVersionUID = -5108854841843722536L;
 
+    /** The sample mean */
     private double mean = Double.NaN;
+    
+    /** The sample variance */
     private double variance = Double.NaN;
+    
+    /** The number of observations in the sample */
     private long n = 0;
+    
+    /** The maximum value */
     private double max = Double.NaN;
+    
+    /** The minimum value */
     private double min = Double.NaN;
+    
+    /** The sum of the sample values */
     private double sum = Double.NaN;
     
     /**
       * Constructor
       * 
-      * @param mean
-      * @param variance
-      * @param n
-      * @param max
-      * @param min
-      * @param sum
+      * @param mean  the sample mean
+      * @param variance  the sample variance
+      * @param n  the number of observations in the sample 
+      * @param max  the maximum value
+      * @param min  the minimum value
+      * @param sum  the sum of the values
      */
     public StatisticalSummaryValues(double mean, double variance, long n,
         double max, double min, double sum) {
@@ -57,6 +67,7 @@ public class StatisticalSummaryValues implements Serializable, StatisticalSummar
         this.sum = sum;
     }
     
+    /** Private no argument contstructor */
     private StatisticalSummaryValues() {
         super();
     }