[Lemon-commits] [lemon_svn] alpar: r2944 - hugo/trunk/lemon

[Lemon SVN]

Author: alpar
Date: Thu Sep 14 20:39:07 2006
New Revision: 2944

Modified:
   hugo/trunk/lemon/dim2.h
   hugo/trunk/lemon/eps.h

Log:
Doc improvements

Modified: hugo/trunk/lemon/dim2.h
==============================================================================
--- hugo/trunk/lemon/dim2.h	(original)
+++ hugo/trunk/lemon/dim2.h	Thu Sep 14 20:39:07 2006
@@ -455,14 +455,8 @@
         }
         return *this;
       }
-  
-//       ///Sums a bounding box and a point
-//       BoundingBox operator +(const Point<T>& u){
-//         BoundingBox b = *this;
-//         return b += u;
-//       }
-
-      ///Increments a bounding box with another bounding box
+    
+      ///Increments a bounding to contain another bounding box
       BoundingBox& add(const BoundingBox &u){
         if ( !u.empty() ){
           this->add(u.bottomLeft());
@@ -471,13 +465,6 @@
         return *this;
       }
   
-      ///Sums two bounding boxes
-      BoundingBox operator +(const BoundingBox& u){
-        BoundingBox b = *this;
-        return b.add(u);
-      }
-
-
       ///Intersection of two bounding boxes
       BoundingBox operator &(const BoundingBox& u){
         BoundingBox b;
@@ -496,6 +483,7 @@
   ///Map of x-coordinates of a dim2::Point<>-map
 
   ///\ingroup maps
+  ///Map of x-coordinates of a dim2::Point<>-map
   ///
   template<class M>
   class XMap 
@@ -532,6 +520,7 @@
   ///Constant (read only) version of \ref XMap
 
   ///\ingroup maps
+  ///Constant (read only) version of \ref XMap
   ///
   template<class M>
   class ConstXMap 
@@ -561,6 +550,7 @@
   ///Map of y-coordinates of a dim2::Point<>-map
     
   ///\ingroup maps
+  ///Map of y-coordinates of a dim2::Point<>-map
   ///
   template<class M>
   class YMap 
@@ -597,6 +587,7 @@
   ///Constant (read only) version of \ref YMap
 
   ///\ingroup maps
+  ///Constant (read only) version of \ref YMap
   ///
   template<class M>
   class ConstYMap 
@@ -624,11 +615,13 @@
   }
 
 
-  ///Map of the \ref Point::normSquare() "normSquare()" of an \ref Point "Point"-map
-
-  ///Map of the \ref Point::normSquare() "normSquare()" of an \ref Point "Point"-map
-  ///\ingroup maps
-  ///
+    ///\brief Map of the \ref Point::normSquare() "normSquare()"
+    ///of an \ref Point "Point"-map
+    ///
+    ///Map of the \ref Point::normSquare() "normSquare()"
+    ///of an \ref Point "Point"-map
+    ///\ingroup maps
+    ///
   template<class M>
   class NormSquareMap 
   {

Modified: hugo/trunk/lemon/eps.h
==============================================================================
--- hugo/trunk/lemon/eps.h	(original)
+++ hugo/trunk/lemon/eps.h	Thu Sep 14 20:39:07 2006
@@ -205,8 +205,8 @@
     ///\ref lineTo(), \ref moveTo() will not take place immediately, but istead
     ///they
     ///are collected. These operations form a \e path.
-    ///Then you can \ref stroke(), \ref fill(), \ref eofill(), \ref clip() or
-    ///\ref eoclip() it.
+    ///Then you can \ref stroke(), \ref fill(), \ref eoFill(), \ref clip() or
+    ///\ref eoClip() it.
     ///When drawing, you can also use \ref closePath() to - surprise - close the
     ///current path.
     ///
@@ -222,26 +222,26 @@
     ///Stroke (draw) a path
 
     ///Stroke (draw) a path.
-    ///\sa collect
+    ///\sa collect()
     ///
     EpsDrawer &stroke();
     ///Fill a path
 
     ///Fill a path.
-    ///\sa collect
+    ///\sa collect()
     ///
     EpsDrawer &fill();
     ///Even-odd fill a path
 
     ///Even-odd fill a path.
-    ///\sa collect
+    ///\sa collect()
     ///
     EpsDrawer &eoFill();
     ///Set a clipping area.
 
     ///This function sets a clipping area. After that, the drawing operations
     ///will affect only this area.
-    ///\sa collect
+    ///\sa collect()
     ///
     EpsDrawer &clip();
     ///Set a clipping area using even-odd rule.
@@ -249,7 +249,7 @@
     ///This function sets a clipping area using even-odd rule.
     ///After that, the drawing operations
     ///will affect only this area.
-    ///\sa collect
+    ///\sa collect()
     ///
     EpsDrawer &eoClip();