Fix several doxygen warnings
authorAlpar Juttner <alpar@cs.elte.hu>
Mon, 07 Jan 2008 19:27:17 +0100
changeset 423a98515e9bc3
parent 41 b11737922197
child 44 7bbd94715db5
Fix several doxygen warnings
lemon/dim2.h
lemon/maps.h
lemon/tolerance.h
     1.1 --- a/lemon/dim2.h	Mon Jan 07 19:23:03 2008 +0100
     1.2 +++ b/lemon/dim2.h	Mon Jan 07 19:27:17 2008 +0100
     1.3 @@ -533,10 +533,10 @@
     1.4      };//class Boundingbox
     1.5  
     1.6  
     1.7 -  ///Map of x-coordinates of a \ref Point "Point"-map
     1.8 +  ///Map of x-coordinates of a Point map
     1.9  
    1.10    ///\ingroup maps
    1.11 -  ///Map of x-coordinates of a \ref Point "Point"-map.
    1.12 +  ///Map of x-coordinates of a \ref dim2::Point "Point"-map.
    1.13    ///
    1.14    template<class M>
    1.15    class XMap 
    1.16 @@ -570,7 +570,7 @@
    1.17      return XMap<M>(m);
    1.18    }
    1.19  
    1.20 -  ///Constant (read only) version of \ref XMap
    1.21 +  ///Constant (read only) version of XMap
    1.22  
    1.23    ///\ingroup maps
    1.24    ///Constant (read only) version of \ref XMap
    1.25 @@ -600,7 +600,7 @@
    1.26      return ConstXMap<M>(m);
    1.27    }
    1.28  
    1.29 -  ///Map of y-coordinates of a \ref Point "Point"-map
    1.30 +  ///Map of y-coordinates of a Point map
    1.31      
    1.32    ///\ingroup maps
    1.33    ///Map of y-coordinates of a \ref Point "Point"-map.
    1.34 @@ -637,7 +637,7 @@
    1.35      return YMap<M>(m);
    1.36    }
    1.37  
    1.38 -  ///Constant (read only) version of \ref YMap
    1.39 +  ///Constant (read only) version of YMap
    1.40  
    1.41    ///\ingroup maps
    1.42    ///Constant (read only) version of \ref YMap
    1.43 @@ -668,8 +668,8 @@
    1.44    }
    1.45  
    1.46  
    1.47 -    ///\brief Map of the \ref Point::normSquare() "normSquare()"
    1.48 -    ///of a \ref Point "Point"-map
    1.49 +    ///\brief Map of the normSquare()
    1.50 +    ///of a Point map
    1.51      ///
    1.52      ///Map of the \ref Point::normSquare() "normSquare()"
    1.53      ///of a \ref Point "Point"-map.
     2.1 --- a/lemon/maps.h	Mon Jan 07 19:23:03 2008 +0100
     2.2 +++ b/lemon/maps.h	Mon Jan 07 19:27:17 2008 +0100
     2.3 @@ -174,13 +174,13 @@
     2.4    public:
     2.5  
     2.6      typedef True ReferenceMapTag;
     2.7 -    ///\e
     2.8 +    ///Key type
     2.9      typedef K Key;
    2.10 -    ///\e
    2.11 +    ///Value type
    2.12      typedef T Value;
    2.13 -    ///\e
    2.14 +    ///Reference Type
    2.15      typedef T& Reference;
    2.16 -    ///\e
    2.17 +    ///Const reference type
    2.18      typedef const T& ConstReference;
    2.19  
    2.20    private:
     3.1 --- a/lemon/tolerance.h	Mon Jan 07 19:23:03 2008 +0100
     3.2 +++ b/lemon/tolerance.h	Mon Jan 07 19:27:17 2008 +0100
     3.3 @@ -41,7 +41,7 @@
     3.4    ///as a result of a probably inexact computation.
     3.5    ///
     3.6    ///This is an abstract class, it should be specialized for all numerical
     3.7 -  ///data types. These specialized classes like \ref Tolerance\<double\>
     3.8 +  ///data types. These specialized classes like Tolerance<double>
     3.9    ///may offer additional tuning parameters.
    3.10    ///
    3.11    ///\sa Tolerance<float>
    3.12 @@ -91,9 +91,9 @@
    3.13    };
    3.14  
    3.15  
    3.16 -  ///Float specialization of \ref Tolerance.
    3.17 +  ///Float specialization of Tolerance.
    3.18  
    3.19 -  ///Float specialization of \ref Tolerance.
    3.20 +  ///Float specialization of Tolerance.
    3.21    ///\sa Tolerance
    3.22    ///\relates Tolerance
    3.23    template<>
    3.24 @@ -142,9 +142,9 @@
    3.25      static Value zero() {return 0;}
    3.26    };
    3.27  
    3.28 -  ///Double specialization of \ref Tolerance.
    3.29 +  ///Double specialization of Tolerance.
    3.30  
    3.31 -  ///Double specialization of \ref Tolerance.
    3.32 +  ///Double specialization of Tolerance.
    3.33    ///\sa Tolerance
    3.34    ///\relates Tolerance
    3.35    template<>
    3.36 @@ -193,9 +193,9 @@
    3.37      static Value zero() {return 0;}
    3.38    };
    3.39  
    3.40 -  ///Long double specialization of \ref Tolerance.
    3.41 +  ///Long double specialization of Tolerance.
    3.42  
    3.43 -  ///Long double specialization of \ref Tolerance.
    3.44 +  ///Long double specialization of Tolerance.
    3.45    ///\sa Tolerance
    3.46    ///\relates Tolerance
    3.47    template<>
    3.48 @@ -244,9 +244,9 @@
    3.49      static Value zero() {return 0;}
    3.50    };
    3.51  
    3.52 -  ///Integer specialization of \ref Tolerance.
    3.53 +  ///Integer specialization of Tolerance.
    3.54  
    3.55 -  ///Integer specialization of \ref Tolerance.
    3.56 +  ///Integer specialization of Tolerance.
    3.57    ///\sa Tolerance
    3.58    template<>
    3.59    class Tolerance<int>
    3.60 @@ -256,7 +256,7 @@
    3.61      typedef int Value;
    3.62  
    3.63      ///\name Comparisons
    3.64 -    ///See \ref Tolerance for more details.
    3.65 +    ///See Tolerance for more details.
    3.66  
    3.67      ///@{
    3.68  
    3.69 @@ -277,7 +277,7 @@
    3.70      static Value zero() {return 0;}
    3.71    };
    3.72  
    3.73 -  ///Unsigned integer specialization of \ref Tolerance.
    3.74 +  ///Unsigned integer specialization of Tolerance.
    3.75  
    3.76    ///Unsigned integer specialization of \ref Tolerance.
    3.77    ///\sa Tolerance
    3.78 @@ -289,7 +289,7 @@
    3.79      typedef unsigned int Value;
    3.80  
    3.81      ///\name Comparisons
    3.82 -    ///See \ref Tolerance for more details.
    3.83 +    ///See Tolerance for more details.
    3.84  
    3.85      ///@{
    3.86  
    3.87 @@ -311,9 +311,9 @@
    3.88    };
    3.89    
    3.90  
    3.91 -  ///Long integer specialization of \ref Tolerance.
    3.92 +  ///Long integer specialization of Tolerance.
    3.93  
    3.94 -  ///Long integer specialization of \ref Tolerance.
    3.95 +  ///Long integer specialization of Tolerance.
    3.96    ///\sa Tolerance
    3.97    template<>
    3.98    class Tolerance<long int>
    3.99 @@ -323,7 +323,7 @@
   3.100      typedef long int Value;
   3.101  
   3.102      ///\name Comparisons
   3.103 -    ///See \ref Tolerance for more details.
   3.104 +    ///See Tolerance for more details.
   3.105  
   3.106      ///@{
   3.107  
   3.108 @@ -344,7 +344,7 @@
   3.109      static Value zero() {return 0;}
   3.110    };
   3.111  
   3.112 -  ///Unsigned long integer specialization of \ref Tolerance.
   3.113 +  ///Unsigned long integer specialization of Tolerance.
   3.114  
   3.115    ///Unsigned long integer specialization of \ref Tolerance.
   3.116    ///\sa Tolerance
   3.117 @@ -356,7 +356,7 @@
   3.118      typedef unsigned long int Value;
   3.119  
   3.120      ///\name Comparisons
   3.121 -    ///See \ref Tolerance for more details.
   3.122 +    ///See Tolerance for more details.
   3.123  
   3.124      ///@{
   3.125  
   3.126 @@ -379,7 +379,7 @@
   3.127  
   3.128  #if defined __GNUC__ && !defined __STRICT_ANSI__
   3.129  
   3.130 -  ///Long long integer specialization of \ref Tolerance.
   3.131 +  ///Long long integer specialization of Tolerance.
   3.132  
   3.133    ///Long long integer specialization of \ref Tolerance.
   3.134    ///\warning This class (more exactly, type <tt>long long</tt>)
   3.135 @@ -414,7 +414,7 @@
   3.136      static Value zero() {return 0;}
   3.137    };
   3.138  
   3.139 -  ///Unsigned long long integer specialization of \ref Tolerance.
   3.140 +  ///Unsigned long long integer specialization of Tolerance.
   3.141  
   3.142    ///Unsigned long long integer specialization of \ref Tolerance.
   3.143    ///\warning This class (more exactly, type <tt>unsigned long long</tt>)