Changeset 689:86c49553fea5 in lemon-main for lemon/circulation.h

Timestamp:

08/18/09 10:35:35 (15 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Test file + doc improvements (#307)

File:

• lemon/circulation.h (modified) (2 diffs)

lemon/circulation.h

@@ -451 +451 @@
     }
 
-    /// \brief Sets the tolerance used by algorithm.
-    ///
-    /// Sets the tolerance used by algorithm.
+    /// \brief Sets the tolerance used by the algorithm.
+    ///
+    /// Sets the tolerance object used by the algorithm.
+    /// \return <tt>(*this)</tt>
     Circulation& tolerance(const Tolerance& tolerance) {
       _tol = tolerance;
@@ -461 +462 @@
     /// \brief Returns a const reference to the tolerance.
     ///
-    /// Returns a const reference to the tolerance.
+    /// Returns a const reference to the tolerance object used by
+    /// the algorithm.
     const Tolerance& tolerance() const {
       return _tol;