# HG changeset patch
# User Peter Kovacs <kpeter@inf.elte.hu>
# Date 1199757222 -3600
# Node ID 9a556af88710d35188e75076a76676bd40002589
# Parent  7bbd94715db50c9020c6bfbcce7efc61a96f7c92
Doc improvements is some files.

diff -r 7bbd94715db5 -r 9a556af88710 lemon/base.cc
--- a/lemon/base.cc	Mon Jan 07 19:44:18 2008 +0100
+++ b/lemon/base.cc	Tue Jan 08 02:53:42 2008 +0100
@@ -17,7 +17,7 @@
  */
 
 ///\file
-///\brief Some basic non inline function and static global data.
+///\brief Some basic non-inline functions and static global data.
 
 #include<lemon/tolerance.h>
 #include<lemon/bits/invalid.h>
diff -r 7bbd94715db5 -r 9a556af88710 lemon/bits/invalid.h
--- a/lemon/bits/invalid.h	Mon Jan 07 19:44:18 2008 +0100
+++ b/lemon/bits/invalid.h	Tue Jan 08 02:53:42 2008 +0100
@@ -26,6 +26,7 @@
 
   /// \brief Dummy type to make it easier to create invalid iterators.
   ///
+  /// Dummy type to make it easier to create invalid iterators.
   /// See \ref INVALID for the usage.
   struct Invalid {
   public:
diff -r 7bbd94715db5 -r 9a556af88710 lemon/dim2.h
--- a/lemon/dim2.h	Mon Jan 07 19:44:18 2008 +0100
+++ b/lemon/dim2.h	Tue Jan 08 02:53:42 2008 +0100
@@ -27,8 +27,7 @@
 ///\brief A simple two dimensional vector and a bounding box implementation 
 ///
 /// The class \ref lemon::dim2::Point "dim2::Point" implements
-///a two dimensional vector with the usual
-/// operations.
+/// a two dimensional vector with the usual operations.
 ///
 /// The class \ref lemon::dim2::BoundingBox "dim2::BoundingBox"
 /// can be used to determine
@@ -49,9 +48,7 @@
   /// A simple two dimensional vector (plainvector) implementation
 
   /// A simple two dimensional vector (plainvector) implementation
-  ///with the usual vector
-  /// operators.
-  ///
+  /// with the usual vector operations.
   template<typename T>
     class Point {
 
@@ -70,7 +67,7 @@
       ///Construct an instance from coordinates
       Point(T a, T b) : x(a), y(b) { }
 
-      ///The dimension of the vector.
+      ///Returns the dimension of the vector (i.e. returns 2).
 
       ///The dimension of the vector.
       ///This function always returns 2. 
@@ -96,14 +93,14 @@
         return x*x+y*y;
       }
   
-      ///Increment the left hand side by u
+      ///Increment the left hand side by \c u
       Point<T>& operator +=(const Point<T>& u) {
         x += u.x;
         y += u.y;
         return *this;
       }
   
-      ///Decrement the left hand side by u
+      ///Decrement the left hand side by \c u
       Point<T>& operator -=(const Point<T>& u) {
         x -= u.x;
         y -= u.y;
@@ -315,6 +312,7 @@
       ///Return \c true if the bounding box is empty (i.e. return \c false
       ///if at least one point was added to the box or the coordinates of
       ///the box were set).
+      ///
       ///The coordinates of an empty bounding box are not defined. 
       bool empty() const {
         return _empty;
@@ -325,66 +323,66 @@
         _empty=1;
       }
 
-      ///Give back the bottom left corner
+      ///Give back the bottom left corner of the box
 
-      ///Give back the bottom left corner.
+      ///Give back the bottom left corner of the box.
       ///If the bounding box is empty, then the return value is not defined.
       Point<T> bottomLeft() const {
         return bottom_left;
       }
 
-      ///Set the bottom left corner
+      ///Set the bottom left corner of the box
 
-      ///Set the bottom left corner.
+      ///Set the bottom left corner of the box.
       ///It should only be used for non-empty box.
       void bottomLeft(Point<T> p) {
 	bottom_left = p;
       }
 
-      ///Give back the top right corner
+      ///Give back the top right corner of the box
 
-      ///Give back the top right corner.
+      ///Give back the top right corner of the box.
       ///If the bounding box is empty, then the return value is not defined.
       Point<T> topRight() const {
         return top_right;
       }
 
-      ///Set the top right corner
+      ///Set the top right corner of the box
 
-      ///Set the top right corner.
+      ///Set the top right corner of the box.
       ///It should only be used for non-empty box.
       void topRight(Point<T> p) {
 	top_right = p;
       }
 
-      ///Give back the bottom right corner
+      ///Give back the bottom right corner of the box
 
-      ///Give back the bottom right corner.
+      ///Give back the bottom right corner of the box.
       ///If the bounding box is empty, then the return value is not defined.
       Point<T> bottomRight() const {
         return Point<T>(top_right.x,bottom_left.y);
       }
 
-      ///Set the bottom right corner
+      ///Set the bottom right corner of the box
 
-      ///Set the bottom right corner.
+      ///Set the bottom right corner of the box.
       ///It should only be used for non-empty box.
       void bottomRight(Point<T> p) {
 	top_right.x = p.x;
 	bottom_left.y = p.y;
       }
  
-      ///Give back the top left corner
+      ///Give back the top left corner of the box
 
-      ///Give back the top left corner.
+      ///Give back the top left corner of the box.
       ///If the bounding box is empty, then the return value is not defined.
       Point<T> topLeft() const {
         return Point<T>(bottom_left.x,top_right.y);
       }
 
-      ///Set the top left corner
+      ///Set the top left corner of the box
 
-      ///Set the top left corner.
+      ///Set the top left corner of the box.
       ///It should only be used for non-empty box.
       void topLeft(Point<T> p) {
 	top_right.y = p.y;
@@ -533,10 +531,10 @@
     };//class Boundingbox
 
 
-  ///Map of x-coordinates of a Point map
+  ///Map of x-coordinates of a \ref Point "Point"-map
 
   ///\ingroup maps
-  ///Map of x-coordinates of a \ref dim2::Point "Point"-map.
+  ///Map of x-coordinates of a \ref Point "Point"-map.
   ///
   template<class M>
   class XMap 
@@ -570,7 +568,7 @@
     return XMap<M>(m);
   }
 
-  ///Constant (read only) version of XMap
+  ///Constant (read only) version of \ref XMap
 
   ///\ingroup maps
   ///Constant (read only) version of \ref XMap
@@ -600,7 +598,7 @@
     return ConstXMap<M>(m);
   }
 
-  ///Map of y-coordinates of a Point map
+  ///Map of y-coordinates of a \ref Point "Point"-map
     
   ///\ingroup maps
   ///Map of y-coordinates of a \ref Point "Point"-map.
@@ -637,7 +635,7 @@
     return YMap<M>(m);
   }
 
-  ///Constant (read only) version of YMap
+  ///Constant (read only) version of \ref YMap
 
   ///\ingroup maps
   ///Constant (read only) version of \ref YMap
@@ -668,13 +666,12 @@
   }
 
 
-    ///\brief Map of the normSquare()
-    ///of a Point map
-    ///
-    ///Map of the \ref Point::normSquare() "normSquare()"
-    ///of a \ref Point "Point"-map.
-    ///\ingroup maps
-    ///
+  ///\brief Map of the \ref Point::normSquare() "normSquare()"
+  ///of a \ref Point "Point"-map
+  ///
+  ///Map of the \ref Point::normSquare() "normSquare()"
+  ///of a \ref Point "Point"-map.
+  ///\ingroup maps
   template<class M>
   class NormSquareMap 
   {
diff -r 7bbd94715db5 -r 9a556af88710 lemon/random.h
--- a/lemon/random.h	Mon Jan 07 19:44:18 2008 +0100
+++ b/lemon/random.h	Tue Jan 08 02:53:42 2008 +0100
@@ -510,7 +510,7 @@
   /// bool h = rnd.boolean(0.8);            // P(h = true) = 0.8
   ///\endcode
   ///
-  /// The lemon provides a global instance of the random number
+  /// LEMON provides a global instance of the random number
   /// generator which name is \ref lemon::rnd "rnd". Usually it is a
   /// good programming convenience to use this global generator to get
   /// random numbers.
@@ -526,12 +526,12 @@
 
   public:
 
-    /// \brief Constructor
+    /// \brief Default constructor
     ///
     /// Constructor with constant seeding.
     Random() { core.initState(); }
 
-    /// \brief Constructor
+    /// \brief Constructor with seed
     ///
     /// Constructor with seed. The current number type will be converted
     /// to the architecture word type.
@@ -540,7 +540,7 @@
       _random_bits::Initializer<Number, Word>::init(core, seed);
     }
 
-    /// \brief Constructor
+    /// \brief Constructor with array seeding
     ///
     /// Constructor with array seeding. The given range should contain
     /// any number type and the numbers will be converted to the
@@ -577,7 +577,7 @@
     /// \brief Returns a random real number from the range [0, 1)
     ///
     /// It returns a random real number from the range [0, 1). The
-    /// default Number type is double.
+    /// default Number type is \c double.
     template <typename Number>
     Number real() {
       return _random_bits::RealConversion<Number, Word>::convert(core);
@@ -653,8 +653,8 @@
     /// \brief Returns a random non-negative integer
     ///
     /// It returns a random non-negative integer uniformly from the
-    /// whole range of the current \c Number type.  The default result
-    /// type of this function is unsigned int.
+    /// whole range of the current \c Number type. The default result
+    /// type of this function is <tt>unsigned int</tt>.
     template <typename Number>
     Number uinteger() {
       return _random_bits::IntConversion<Number, Word>::convert(core);
@@ -668,7 +668,7 @@
     ///
     /// It returns a random integer uniformly from the whole range of
     /// the current \c Number type. The default result type of this
-    /// function is int.
+    /// function is \c int.
     template <typename Number>
     Number integer() {
       static const int nb = std::numeric_limits<Number>::digits + 
@@ -689,7 +689,7 @@
       return bool_producer.convert(core);
     }
 
-    ///\name Nonuniform distributions
+    ///\name Non-uniform distributions
     ///
     
     ///@{
diff -r 7bbd94715db5 -r 9a556af88710 lemon/tolerance.h
--- a/lemon/tolerance.h	Mon Jan 07 19:44:18 2008 +0100
+++ b/lemon/tolerance.h	Tue Jan 08 02:53:42 2008 +0100
@@ -36,25 +36,21 @@
   ///handle the comparison of numbers that are obtained
   ///as a result of a probably inexact computation.
   ///
-  ///Tolerance is a class to provide a basic way to
+  ///\ref Tolerance is a class to provide a basic way to
   ///handle the comparison of numbers that are obtained
   ///as a result of a probably inexact computation.
   ///
   ///This is an abstract class, it should be specialized for all numerical
-  ///data types. These specialized classes like Tolerance<double>
+  ///data types. These specialized classes like \ref Tolerance<double>
   ///may offer additional tuning parameters.
   ///
   ///\sa Tolerance<float>
   ///\sa Tolerance<double>
   ///\sa Tolerance<long double>
   ///\sa Tolerance<int>
-#if defined __GNUC__ && !defined __STRICT_ANSI__  
   ///\sa Tolerance<long long int>
-#endif
   ///\sa Tolerance<unsigned int>
-#if defined __GNUC__ && !defined __STRICT_ANSI__  
   ///\sa Tolerance<unsigned long long int>
-#endif
 
   template<class T>
   class Tolerance
@@ -63,7 +59,7 @@
     typedef T Value;
 
     ///\name Comparisons
-    ///The concept is that these bool functions return with \c true only if
+    ///The concept is that these bool functions return \c true only if
     ///the related comparisons hold even if some numerical error appeared
     ///during the computations.
 
@@ -107,21 +103,21 @@
 
     ///Constructor setting the epsilon tolerance to the default value.
     Tolerance() : _epsilon(def_epsilon) {}
-    ///Constructor setting the epsilon tolerance.
+    ///Constructor setting the epsilon tolerance to the given value.
     Tolerance(float e) : _epsilon(e) {}
 
-    ///Return the epsilon value.
+    ///Returns the epsilon value.
     Value epsilon() const {return _epsilon;}
-    ///Set the epsilon value.
+    ///Sets the epsilon value.
     void epsilon(Value e) {_epsilon=e;}
 
-    ///Return the default epsilon value.
+    ///Returns the default epsilon value.
     static Value defaultEpsilon() {return def_epsilon;}
-    ///Set the default epsilon value.
+    ///Sets the default epsilon value.
     static void defaultEpsilon(Value e) {def_epsilon=e;}
 
     ///\name Comparisons
-    ///See class Tolerance for more details.
+    ///See \ref Tolerance for more details.
 
     ///@{
 
@@ -158,21 +154,21 @@
 
     ///Constructor setting the epsilon tolerance to the default value.
     Tolerance() : _epsilon(def_epsilon) {}
-    ///Constructor setting the epsilon tolerance.
+    ///Constructor setting the epsilon tolerance to the given value.
     Tolerance(double e) : _epsilon(e) {}
 
-    ///Return the epsilon value.
+    ///Returns the epsilon value.
     Value epsilon() const {return _epsilon;}
-    ///Set the epsilon value.
+    ///Sets the epsilon value.
     void epsilon(Value e) {_epsilon=e;}
 
-    ///Return the default epsilon value.
+    ///Returns the default epsilon value.
     static Value defaultEpsilon() {return def_epsilon;}
-    ///Set the default epsilon value.
+    ///Sets the default epsilon value.
     static void defaultEpsilon(Value e) {def_epsilon=e;}
 
     ///\name Comparisons
-    ///See class Tolerance for more details.
+    ///See \ref Tolerance for more details.
 
     ///@{
 
@@ -209,21 +205,21 @@
 
     ///Constructor setting the epsilon tolerance to the default value.
     Tolerance() : _epsilon(def_epsilon) {}
-    ///Constructor setting the epsilon tolerance.
+    ///Constructor setting the epsilon tolerance to the given value.
     Tolerance(long double e) : _epsilon(e) {}
 
-    ///Return the epsilon value.
+    ///Returns the epsilon value.
     Value epsilon() const {return _epsilon;}
-    ///Set the epsilon value.
+    ///Sets the epsilon value.
     void epsilon(Value e) {_epsilon=e;}
 
-    ///Return the default epsilon value.
+    ///Returns the default epsilon value.
     static Value defaultEpsilon() {return def_epsilon;}
-    ///Set the default epsilon value.
+    ///Sets the default epsilon value.
     static void defaultEpsilon(Value e) {def_epsilon=e;}
 
     ///\name Comparisons
-    ///See class Tolerance for more details.
+    ///See \ref Tolerance for more details.
 
     ///@{
 
@@ -256,7 +252,7 @@
     typedef int Value;
 
     ///\name Comparisons
-    ///See Tolerance for more details.
+    ///See \ref Tolerance for more details.
 
     ///@{
 
@@ -289,7 +285,7 @@
     typedef unsigned int Value;
 
     ///\name Comparisons
-    ///See Tolerance for more details.
+    ///See \ref Tolerance for more details.
 
     ///@{
 
@@ -323,7 +319,7 @@
     typedef long int Value;
 
     ///\name Comparisons
-    ///See Tolerance for more details.
+    ///See \ref Tolerance for more details.
 
     ///@{
 
@@ -356,7 +352,7 @@
     typedef unsigned long int Value;
 
     ///\name Comparisons
-    ///See Tolerance for more details.
+    ///See \ref Tolerance for more details.
 
     ///@{