Changeset 178:d2bac07f1742 in lemon-main

Timestamp:

04/15/08 14:12:10 (17 years ago)

Author:

Alpar Juttner <alpar@…>

Branch:

default

Phase:

public

Message:

Doc improvements in random.h

File:

• lemon/random.h (modified) (5 diffs)

lemon/random.h

@@ -541 +541 @@
     /// @{
 
+    ///\name Initialization
+    ///
+    /// @{
+
     /// \brief Default constructor
     ///
@@ -612 +616 @@
     ///
     /// By default, this function calls the \c seedFromFile() member
-    /// function with the <tt>/dev/urandom</tt> file. If it is not success,
+    /// function with the <tt>/dev/urandom</tt> file. If it does not success,
     /// it uses the \c seedFromTime().
     /// \return Currently always true.
@@ -635 +639 @@
     /// \param file The source file
     /// \param offset The offset, from the file read.
-    /// \return True when the seeding is success.
+    /// \return True when the seeding successes.
 #ifndef WIN32
     bool seedFromFile(const std::string& file = "/dev/urandom", int offset = 0) 
@@ -705 +709 @@
     }
 
+    /// @}
+
+    ///\name Uniform distributions
+    ///
+    /// @{
+
     /// \brief Returns a random real number from the range [0, 1)
     ///
@@ -761 +771 @@
       return _random_bits::IntConversion<Number, Word>::convert(core);
     }
+
+    /// @}
 
     unsigned int uinteger() {