Changeset 1187

Timestamp:

Feb 28, 2008, 10:06:54 PM (16 years ago)

Author:

Peter

Message:

minor docs issues fixed

File:

• trunk/yat/statistics/AveragerPair.h (modified) (3 diffs)

trunk/yat/statistics/AveragerPair.h

@@ -71 +71 @@
 
     /**
+       \brief Concordence correlation coefficient.
+
        \f$ \frac{\sum_i (x_i-m_x)(y_i-m_y)}{\sum_i
        (x_i-m_x)^2+\sum_i (y_i-m_y)^2 + n(m_x-m_y)^2} \f$ 
        
-       @return Concordence correlation coefficient.
     */
     double ccc(void) const;
 
-    ///
-    /// \f$ \frac{\sum_i (x_i-m_x)(y_i-m_y)}{\sqrt{\sum_i
-    /// (x_i-m_x)^2\sum_i (y_i-m_y)^2}} \f$ 
-    ///
-    /// @return %Pearson correlation coefficient.
-    ///
+    /**
+       \f$ \frac{\sum_i (x_i-m_x)(y_i-m_y)}{\sqrt{\sum_i
+       (x_i-m_x)^2\sum_i (y_i-m_y)^2}} \f$ 
+       
+       \return %Pearson correlation coefficient.
+    */
     double correlation(void) const;
   
@@ -100 +101 @@
     double mean_xy(void) const;
 
-    ///
-    /// @return Average squared deviation between x and y \f$
-    /// \frac{1}{N} \sum (x-y)^2 \f$
-    ///
+    /**
+       \return Average squared deviation between x and y \f$
+       \frac{1}{N} \sum (x-y)^2 \f$
+    */
     double msd(void) const;
 
@@ -121 +122 @@
     double sum_xy(void) const;
 
-    ///
-    /// @return Sum of squared deviation between x and y \f$
-    /// \sum (x-y)^2 \f$
-    ///
+    /**
+       \return Sum of squared deviation between x and y \f$
+       \sum (x-y)^2 \f$
+    */
     double sum_squared_deviation(void) const;