lemon/dim2.h
changeset 315 c175e387da19
parent 313 64f8f7cc6168
child 440 88ed40ad0d4f
     1.1 --- a/lemon/dim2.h	Thu Oct 09 13:40:40 2008 +0100
     1.2 +++ b/lemon/dim2.h	Thu Oct 09 13:54:50 2008 +0100
     1.3 @@ -259,10 +259,10 @@
     1.4  
     1.5  
     1.6  
     1.7 -  /// Bounding box of plain vectors (\ref Point points).
     1.8 +  /// Bounding box of plain vectors (points).
     1.9  
    1.10    /// A class to calculate or store the bounding box of plain vectors
    1.11 -  /// (\ref Point points).
    1.12 +  /// (\ref Point "points").
    1.13    template<typename T>
    1.14    class Box {
    1.15        Point<T> _bottom_left, _top_right;
    1.16 @@ -573,9 +573,8 @@
    1.17      return os;
    1.18    }
    1.19  
    1.20 -  ///Map of x-coordinates of a \ref Point "Point"-map
    1.21 +  ///Map of x-coordinates of a <tt>Point</tt>-map
    1.22  
    1.23 -  ///\ingroup maps
    1.24    ///Map of x-coordinates of a \ref Point "Point"-map.
    1.25    ///
    1.26    template<class M>
    1.27 @@ -592,11 +591,9 @@
    1.28      void set(Key k,Value v) {_map.set(k,typename M::Value(v,_map[k].y));}
    1.29    };
    1.30  
    1.31 -  ///Returns an \ref XMap class
    1.32 +  ///Returns an XMap class
    1.33  
    1.34 -  ///This function just returns an \ref XMap class.
    1.35 -  ///
    1.36 -  ///\ingroup maps
    1.37 +  ///This function just returns an XMap class.
    1.38    ///\relates XMap
    1.39    template<class M>
    1.40    inline XMap<M> xMap(M &m)
    1.41 @@ -610,10 +607,9 @@
    1.42      return XMap<M>(m);
    1.43    }
    1.44  
    1.45 -  ///Constant (read only) version of \ref XMap
    1.46 +  ///Constant (read only) version of XMap
    1.47  
    1.48 -  ///\ingroup maps
    1.49 -  ///Constant (read only) version of \ref XMap
    1.50 +  ///Constant (read only) version of XMap.
    1.51    ///
    1.52    template<class M>
    1.53    class ConstXMap
    1.54 @@ -628,11 +624,9 @@
    1.55      Value operator[](Key k) const {return _map[k].x;}
    1.56    };
    1.57  
    1.58 -  ///Returns a \ref ConstXMap class
    1.59 +  ///Returns a ConstXMap class
    1.60  
    1.61 -  ///This function just returns a \ref ConstXMap class.
    1.62 -  ///
    1.63 -  ///\ingroup maps
    1.64 +  ///This function just returns a ConstXMap class.
    1.65    ///\relates ConstXMap
    1.66    template<class M>
    1.67    inline ConstXMap<M> xMap(const M &m)
    1.68 @@ -640,9 +634,8 @@
    1.69      return ConstXMap<M>(m);
    1.70    }
    1.71  
    1.72 -  ///Map of y-coordinates of a \ref Point "Point"-map
    1.73 +  ///Map of y-coordinates of a <tt>Point</tt>-map
    1.74  
    1.75 -  ///\ingroup maps
    1.76    ///Map of y-coordinates of a \ref Point "Point"-map.
    1.77    ///
    1.78    template<class M>
    1.79 @@ -659,11 +652,9 @@
    1.80      void set(Key k,Value v) {_map.set(k,typename M::Value(_map[k].x,v));}
    1.81    };
    1.82  
    1.83 -  ///Returns a \ref YMap class
    1.84 +  ///Returns a YMap class
    1.85  
    1.86 -  ///This function just returns a \ref YMap class.
    1.87 -  ///
    1.88 -  ///\ingroup maps
    1.89 +  ///This function just returns a YMap class.
    1.90    ///\relates YMap
    1.91    template<class M>
    1.92    inline YMap<M> yMap(M &m)
    1.93 @@ -677,10 +668,9 @@
    1.94      return YMap<M>(m);
    1.95    }
    1.96  
    1.97 -  ///Constant (read only) version of \ref YMap
    1.98 +  ///Constant (read only) version of YMap
    1.99  
   1.100 -  ///\ingroup maps
   1.101 -  ///Constant (read only) version of \ref YMap
   1.102 +  ///Constant (read only) version of YMap.
   1.103    ///
   1.104    template<class M>
   1.105    class ConstYMap
   1.106 @@ -695,11 +685,9 @@
   1.107      Value operator[](Key k) const {return _map[k].y;}
   1.108    };
   1.109  
   1.110 -  ///Returns a \ref ConstYMap class
   1.111 +  ///Returns a ConstYMap class
   1.112  
   1.113 -  ///This function just returns a \ref ConstYMap class.
   1.114 -  ///
   1.115 -  ///\ingroup maps
   1.116 +  ///This function just returns a ConstYMap class.
   1.117    ///\relates ConstYMap
   1.118    template<class M>
   1.119    inline ConstYMap<M> yMap(const M &m)
   1.120 @@ -708,12 +696,10 @@
   1.121    }
   1.122  
   1.123  
   1.124 -  ///\brief Map of the \ref Point::normSquare() "normSquare()"
   1.125 -  ///of a \ref Point "Point"-map
   1.126 +  ///\brief Map of the normSquare() of a <tt>Point</tt>-map
   1.127    ///
   1.128    ///Map of the \ref Point::normSquare() "normSquare()"
   1.129    ///of a \ref Point "Point"-map.
   1.130 -  ///\ingroup maps
   1.131    template<class M>
   1.132    class NormSquareMap
   1.133    {
   1.134 @@ -727,11 +713,9 @@
   1.135      Value operator[](Key k) const {return _map[k].normSquare();}
   1.136    };
   1.137  
   1.138 -  ///Returns a \ref NormSquareMap class
   1.139 +  ///Returns a NormSquareMap class
   1.140  
   1.141 -  ///This function just returns a \ref NormSquareMap class.
   1.142 -  ///
   1.143 -  ///\ingroup maps
   1.144 +  ///This function just returns a NormSquareMap class.
   1.145    ///\relates NormSquareMap
   1.146    template<class M>
   1.147    inline NormSquareMap<M> normSquareMap(const M &m)