LEMON/LEMON-main Changeset - r49:9a556af88710

Repositories » LEMON » LEMON-main

Summary
Changelog
Files
Switch To
- loading...
Options
- Lightweight changelog
- Search
Pull Requests

Changeset - r49:9a556af88710

« 44:7bbd94

50:a34c58 »

r49:9a556af88710

Tue, 08 Jan 2008 02:53:42

[Not Reviewed]

0 comments (0 inline)

kpeter (Peter Kovacs)
kpeter@inf.elte.hu

Doc improvements is some files.

0 5 0

default

5 files changed with 64 insertions and 70 deletions:

lemon/base.cc

lemon/bits/invalid.h

lemon/dim2.h

lemon/random.h

lemon/tolerance.h

↑ Collapse diff ↑

lemon/base.cc

Show inline comments

@@ -19,3 +19,3 @@
 		///\file
-		///\brief Some basic non inline function and static global data.
+		///\brief Some basic non-inline functions and static global data.

lemon/bits/invalid.h

Show inline comments

@@ -28,2 +28,3 @@
 		  ///
 		  /// Dummy type to make it easier to create invalid iterators.
 		  /// See \ref INVALID for the usage.

lemon/dim2.h

Show inline comments

@@ -29,4 +29,3 @@
 		/// 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.
 		///
@@ -51,5 +50,3 @@
 		  /// A simple two dimensional vector (plainvector) implementation
 		  ///with the usual vector
 		  /// operators.
 		  ///
+		  /// with the usual vector operations.
 		  template<typename T>
@@ -72,3 +69,3 @@
-		      ///The dimension of the vector.
+		      ///Returns the dimension of the vector (i.e. returns 2).
@@ -98,3 +95,3 @@
 		      ///Increment the left hand side by u
+		      ///Increment the left hand side by \c u
 		      Point<T>& operator +=(const Point<T>& u) {
@@ -105,3 +102,3 @@
 		      ///Decrement the left hand side by u
+		      ///Decrement the left hand side by \c u
 		      Point<T>& operator -=(const Point<T>& u) {
@@ -317,2 +314,3 @@
 		      ///the box were set).
 		      ///
 		      ///The coordinates of an empty bounding box are not defined.
@@ -327,5 +325,5 @@
 		      ///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.
@@ -335,5 +333,5 @@
 		      ///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.
@@ -343,5 +341,5 @@
 		      ///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.
@@ -351,5 +349,5 @@
 		      ///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.
@@ -359,5 +357,5 @@
 		      ///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.
@@ -367,5 +365,5 @@
 		      ///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.
@@ -376,5 +374,5 @@
 		      ///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.
@@ -384,5 +382,5 @@
 		      ///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.
@@ -535,6 +533,6 @@
 		  ///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.
 		  ///
@@ -572,3 +570,3 @@
 		  ///Constant (read only) version of XMap
+		  ///Constant (read only) version of \ref XMap
@@ -602,3 +600,3 @@
 		  ///Map of y-coordinates of a Point map
+		  ///Map of y-coordinates of a \ref Point "Point"-map
@@ -639,3 +637,3 @@
 		  ///Constant (read only) version of YMap
+		  ///Constant (read only) version of \ref YMap
@@ -670,4 +668,4 @@
 		    ///\brief Map of the normSquare()
 		    ///of a Point map
 		  ///\brief Map of the \ref Point::normSquare() "normSquare()"
 		  ///of a \ref Point "Point"-map
 		    ///
@@ -676,3 +674,2 @@
 		    ///\ingroup maps
 		    ///
 		  template<class M>

lemon/random.h

Show inline comments

@@ -512,3 +512,3 @@
 		  ///
-		  /// 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
@@ -528,3 +528,3 @@
-		    /// \brief Constructor
+		    /// \brief Default constructor
 		    ///
@@ -533,3 +533,3 @@
 		    /// \brief Constructor
+		    /// \brief Constructor with seed
 		    ///
@@ -542,3 +542,3 @@
 		    /// \brief Constructor
+		    /// \brief Constructor with array seeding
 		    ///
@@ -579,3 +579,3 @@
 		    /// 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>
@@ -656,3 +656,3 @@
 		    /// whole range of the current \c Number type.  The default result
 		    /// type of this function is unsigned int.
+		    /// type of this function is <tt>unsigned int</tt>.
 		    template <typename Number>
@@ -670,3 +670,3 @@
 		    /// the current \c Number type. The default result type of this
 		    /// function is int.
+		    /// function is \c int.
 		    template <typename Number>
@@ -691,3 +691,3 @@
-		    ///\name Nonuniform distributions
+		    ///\name Non-uniform distributions
 		    ///

lemon/tolerance.h

Show inline comments

@@ -38,3 +38,3 @@
 		  ///
 		  ///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
@@ -43,3 +43,3 @@
 		  ///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.
@@ -50,9 +50,5 @@
 		  ///\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
@@ -65,3 +61,3 @@
 		    ///\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
@@ -109,13 +105,13 @@
 		    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;}
@@ -123,3 +119,3 @@
 		    ///\name Comparisons
-		    ///See class Tolerance for more details.
+		    ///See \ref Tolerance for more details.
@@ -160,13 +156,13 @@
 		    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;}
@@ -174,3 +170,3 @@
 		    ///\name Comparisons
-		    ///See class Tolerance for more details.
+		    ///See \ref Tolerance for more details.
@@ -211,13 +207,13 @@
 		    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;}
@@ -225,3 +221,3 @@
 		    ///\name Comparisons
-		    ///See class Tolerance for more details.
+		    ///See \ref Tolerance for more details.
@@ -258,3 +254,3 @@
 		    ///\name Comparisons
 		    ///See Tolerance for more details.
+		    ///See \ref Tolerance for more details.
@@ -291,3 +287,3 @@
 		    ///\name Comparisons
 		    ///See Tolerance for more details.
+		    ///See \ref Tolerance for more details.
@@ -325,3 +321,3 @@
 		    ///\name Comparisons
 		    ///See Tolerance for more details.
+		    ///See \ref Tolerance for more details.
@@ -358,3 +354,3 @@
 		    ///\name Comparisons
 		    ///See Tolerance for more details.
+		    ///See \ref Tolerance for more details.

0 comments (0 inline)

RhodeCode

Login to your account