Doc improvements.
authoralpar
Fri, 20 Oct 2006 12:06:49 +0000
changeset 22570a9393adc747
parent 2256 b22dfb6c5ff3
child 2258 741995f3dbc4
Doc improvements.
lemon/random.h
     1.1 --- a/lemon/random.h	Fri Oct 20 12:05:54 2006 +0000
     1.2 +++ b/lemon/random.h	Fri Oct 20 12:06:49 2006 +0000
     1.3 @@ -513,7 +513,7 @@
     1.4        return *this;
     1.5      }
     1.6  
     1.7 -    /// \brief Returns a random real number
     1.8 +    /// \brief Returns a random real number from the range [0, 1)
     1.9      ///
    1.10      /// It returns a random real number from the range [0, 1). The
    1.11      /// default Number type is double.
    1.12 @@ -526,7 +526,7 @@
    1.13        return real<double>();
    1.14      }
    1.15  
    1.16 -    /// \brief Returns a random real number
    1.17 +    /// \brief Returns a random real number the range [0, b)
    1.18      ///
    1.19      /// It returns a random real number from the range [0, b).
    1.20      template <typename Number>
    1.21 @@ -534,7 +534,7 @@
    1.22        return real<Number>() * b; 
    1.23      }
    1.24  
    1.25 -    /// \brief Returns a random real number
    1.26 +    /// \brief Returns a random real number from the range [a, b)
    1.27      ///
    1.28      /// It returns a random real number from the range [a, b).
    1.29      template <typename Number>
    1.30 @@ -542,14 +542,14 @@
    1.31        return real<Number>() * (b - a) + a; 
    1.32      }
    1.33  
    1.34 -    /// \brief Returns a random real number
    1.35 +    /// \brief Returns a random real number from the range [0, 1)
    1.36      ///
    1.37      /// It returns a random double from the range [0, 1).
    1.38      double operator()() {
    1.39        return real<double>();
    1.40      }
    1.41  
    1.42 -    /// \brief Returns a random real number
    1.43 +    /// \brief Returns a random real number from the range [0, b)
    1.44      ///
    1.45      /// It returns a random real number from the range [0, b).
    1.46      template <typename Number>
    1.47 @@ -557,7 +557,7 @@
    1.48        return real<Number>() * b; 
    1.49      }
    1.50  
    1.51 -    /// \brief Returns a random real number
    1.52 +    /// \brief Returns a random real number from the range [a, b)
    1.53      ///
    1.54      /// It returns a random real number from the range [a, b).
    1.55      template <typename Number>