Doc improvements
authoralpar
Thu, 14 Sep 2006 18:39:07 +0000
changeset 2214a886e48e0d91
parent 2213 2c094dfa176d
child 2215 83ec156873ab
Doc improvements
lemon/dim2.h
lemon/eps.h
     1.1 --- a/lemon/dim2.h	Fri Sep 08 15:51:32 2006 +0000
     1.2 +++ b/lemon/dim2.h	Thu Sep 14 18:39:07 2006 +0000
     1.3 @@ -455,14 +455,8 @@
     1.4          }
     1.5          return *this;
     1.6        }
     1.7 -  
     1.8 -//       ///Sums a bounding box and a point
     1.9 -//       BoundingBox operator +(const Point<T>& u){
    1.10 -//         BoundingBox b = *this;
    1.11 -//         return b += u;
    1.12 -//       }
    1.13 -
    1.14 -      ///Increments a bounding box with another bounding box
    1.15 +    
    1.16 +      ///Increments a bounding to contain another bounding box
    1.17        BoundingBox& add(const BoundingBox &u){
    1.18          if ( !u.empty() ){
    1.19            this->add(u.bottomLeft());
    1.20 @@ -471,13 +465,6 @@
    1.21          return *this;
    1.22        }
    1.23    
    1.24 -      ///Sums two bounding boxes
    1.25 -      BoundingBox operator +(const BoundingBox& u){
    1.26 -        BoundingBox b = *this;
    1.27 -        return b.add(u);
    1.28 -      }
    1.29 -
    1.30 -
    1.31        ///Intersection of two bounding boxes
    1.32        BoundingBox operator &(const BoundingBox& u){
    1.33          BoundingBox b;
    1.34 @@ -496,6 +483,7 @@
    1.35    ///Map of x-coordinates of a dim2::Point<>-map
    1.36  
    1.37    ///\ingroup maps
    1.38 +  ///Map of x-coordinates of a dim2::Point<>-map
    1.39    ///
    1.40    template<class M>
    1.41    class XMap 
    1.42 @@ -532,6 +520,7 @@
    1.43    ///Constant (read only) version of \ref XMap
    1.44  
    1.45    ///\ingroup maps
    1.46 +  ///Constant (read only) version of \ref XMap
    1.47    ///
    1.48    template<class M>
    1.49    class ConstXMap 
    1.50 @@ -561,6 +550,7 @@
    1.51    ///Map of y-coordinates of a dim2::Point<>-map
    1.52      
    1.53    ///\ingroup maps
    1.54 +  ///Map of y-coordinates of a dim2::Point<>-map
    1.55    ///
    1.56    template<class M>
    1.57    class YMap 
    1.58 @@ -597,6 +587,7 @@
    1.59    ///Constant (read only) version of \ref YMap
    1.60  
    1.61    ///\ingroup maps
    1.62 +  ///Constant (read only) version of \ref YMap
    1.63    ///
    1.64    template<class M>
    1.65    class ConstYMap 
    1.66 @@ -624,11 +615,13 @@
    1.67    }
    1.68  
    1.69  
    1.70 -  ///Map of the \ref Point::normSquare() "normSquare()" of an \ref Point "Point"-map
    1.71 -
    1.72 -  ///Map of the \ref Point::normSquare() "normSquare()" of an \ref Point "Point"-map
    1.73 -  ///\ingroup maps
    1.74 -  ///
    1.75 +    ///\brief Map of the \ref Point::normSquare() "normSquare()"
    1.76 +    ///of an \ref Point "Point"-map
    1.77 +    ///
    1.78 +    ///Map of the \ref Point::normSquare() "normSquare()"
    1.79 +    ///of an \ref Point "Point"-map
    1.80 +    ///\ingroup maps
    1.81 +    ///
    1.82    template<class M>
    1.83    class NormSquareMap 
    1.84    {
     2.1 --- a/lemon/eps.h	Fri Sep 08 15:51:32 2006 +0000
     2.2 +++ b/lemon/eps.h	Thu Sep 14 18:39:07 2006 +0000
     2.3 @@ -205,8 +205,8 @@
     2.4      ///\ref lineTo(), \ref moveTo() will not take place immediately, but istead
     2.5      ///they
     2.6      ///are collected. These operations form a \e path.
     2.7 -    ///Then you can \ref stroke(), \ref fill(), \ref eofill(), \ref clip() or
     2.8 -    ///\ref eoclip() it.
     2.9 +    ///Then you can \ref stroke(), \ref fill(), \ref eoFill(), \ref clip() or
    2.10 +    ///\ref eoClip() it.
    2.11      ///When drawing, you can also use \ref closePath() to - surprise - close the
    2.12      ///current path.
    2.13      ///
    2.14 @@ -222,26 +222,26 @@
    2.15      ///Stroke (draw) a path
    2.16  
    2.17      ///Stroke (draw) a path.
    2.18 -    ///\sa collect
    2.19 +    ///\sa collect()
    2.20      ///
    2.21      EpsDrawer &stroke();
    2.22      ///Fill a path
    2.23  
    2.24      ///Fill a path.
    2.25 -    ///\sa collect
    2.26 +    ///\sa collect()
    2.27      ///
    2.28      EpsDrawer &fill();
    2.29      ///Even-odd fill a path
    2.30  
    2.31      ///Even-odd fill a path.
    2.32 -    ///\sa collect
    2.33 +    ///\sa collect()
    2.34      ///
    2.35      EpsDrawer &eoFill();
    2.36      ///Set a clipping area.
    2.37  
    2.38      ///This function sets a clipping area. After that, the drawing operations
    2.39      ///will affect only this area.
    2.40 -    ///\sa collect
    2.41 +    ///\sa collect()
    2.42      ///
    2.43      EpsDrawer &clip();
    2.44      ///Set a clipping area using even-odd rule.
    2.45 @@ -249,7 +249,7 @@
    2.46      ///This function sets a clipping area using even-odd rule.
    2.47      ///After that, the drawing operations
    2.48      ///will affect only this area.
    2.49 -    ///\sa collect
    2.50 +    ///\sa collect()
    2.51      ///
    2.52      EpsDrawer &eoClip();
    2.53