Changeset 648 for trunk/c++_tools/random

Timestamp:

Sep 14, 2006, 5:04:17 AM (16 years ago)

Author:

Peter

Message:

fixes #133 removed all errors reported from Doxygen. Only one error left which says Index is not documented but I don't want it to be documented actually we use the Doxygens preprocessor to skip documenting that class, yet Doxygen complains that class is not documented huh. Only solution would be to move that class to its own file and not keep it together with SVM.

File:

• trunk/c++_tools/random/random.h (modified) (5 diffs)

trunk/c++_tools/random/random.h

@@ -108 +108 @@
     inline std::string name(void) const { return gsl_rng_name(rng_); }
 
+    ///
+    /// @return const pointer to underlying GSL random generator.
+    ///
     inline const gsl_rng* rng(void) const { return rng_; }
 
@@ -181 +184 @@
     
   protected:
+    /// GSL random gererator
     RNG* rng_;
   };
@@ -360 +364 @@
 
   protected:
+    /// pointer to GSL random generator
     RNG* rng_;
   };
@@ -429 +434 @@
     /// @brief Constructor
     ///
-    /// @param \a m is the expectation value of the distribution.
+    /// @param m is the expectation value of the distribution.
     ///
     inline Exponential(const double m=1) : m_(m) {}
@@ -471 +476 @@
     /// @brief Constructor
     /// @param s is the standard deviation \f$ \sigma \f$ of distribution
-    /// m is the expectation value \f$ \mu \f$ of the distribution
+    /// @param m is the expectation value \f$ \mu \f$ of the distribution
     ///
     inline Gaussian(const double s=1, const double m=0) : m_(m), s_(s) {}