statistics.hh:

fix up some very ambiguous doxygen comments about Formulas

base/statistics.hh:
    fix up some very ambiguous comments about Formulas

--HG--
extra : convert_revision : ad8d9579fd1933397590c78111bec7c0d19b0e14

diff --git a/base/statistics.hh b/base/statistics.hh
index 07d248294eccded23306d9fd5f443232f5bfe60f..a5fc5c6b53976ef88abb29a4209b9e6e19adc051 100644 (file)
--- a/base/statistics.hh
+++ b/base/statistics.hh
@@ -2578,12 +2578,20 @@ class Formula : public Detail::VectorStat
     }
 
     /**
-     * Return the vector of values of this formula.
+     * Return the result of the Fomula in a vector.  If there were no Vector
+     * components to the Formula, then the vector is size 1.  If there were,
+     * like x/y with x being a vector of size 3, then the result returned will
+     * be x[0]/y, x[1]/y, x[2]/y, respectively.
      * @return The result vector.
      */
     const rvec_t &val() const { return root->val(); }
     /**
-     * Return the total of the result vector.
+     * Return the total Formula result.  If there is a Vector component to this
+     * Formula, then this is the result of the Formula if the formula is applied
+     * after summing all the components of the Vector.  For example, if Formula
+     * is x/y where x is size 3, then total() will return (x[1]+x[2]+x[3])/y.  If there is no
+     * Vector component, total() returns the same value as the first entry in the rvec_t
+     * val() returns.
      * @return The total of the result vector.
      */
     result_t total() const { return root->total(); }