Changeset 1308

Timestamp:

May 15, 2008, 6:09:30 PM (15 years ago)

Author:

Peter

Message:

added and corrected some docs

File:

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

trunk/yat/statistics/averager_traits.h

@@ -47 +47 @@
   struct averager_traits<utility::unweighted_iterator_tag> 
   {
-  /** 
-     \see class declaration
-  */
+    /** 
+        Metafunction returning Averager
+    */
     typedef Averager type;
+    /** 
+        Metafunction returning AveragerPair
+    */
     typedef AveragerPair pair_type;
   };
@@ -60 +63 @@
   struct averager_traits<utility::weighted_iterator_tag> 
   {
-  /**
-     \see class declaration
-  */
+    /**
+       Metafunction returning AveragerWeighted
+     */
     typedef AveragerWeighted type;
+    /**
+       Metafunction returning AveragerPairWeighted
+    */
     typedef AveragerPairWeighted pair_type;
   };
@@ -90 +96 @@
   {
   /** 
-      Convenience Metafunction taking iterator as argument and return
-      either Averager (if both iterators are unweighted) or AveragerWeighted
-      otherwise.
+      Convenience Metafunction taking two iterators as argument and
+      return either AveragerPair (if both iterators are unweighted) or
+      AveragerPairWeighted otherwise.
   */
     typedef typename