Changeset 2214:a886e48e0d91 in lemon-0.x

Timestamp:

09/14/06 20:39:07 (18 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2944

Message:

Doc improvements

Location:

lemon

Files:

• dim2.h (modified) (7 diffs)
• eps.h (modified) (6 diffs)

lemon/dim2.h

@@ -456 +456 @@
         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() ){
@@ -472 +466 @@
       }
   
-      ///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){
@@ -497 +484 @@
 
   ///\ingroup maps
+  ///Map of x-coordinates of a dim2::Point<>-map
   ///
   template<class M>
@@ -533 +521 @@
 
   ///\ingroup maps
+  ///Constant (read only) version of \ref XMap
   ///
   template<class M>
@@ -562 +551 @@
     
   ///\ingroup maps
+  ///Map of y-coordinates of a dim2::Point<>-map
   ///
   template<class M>
@@ -598 +588 @@
 
   ///\ingroup maps
+  ///Constant (read only) version of \ref YMap
   ///
   template<class M>
@@ -625 +616 @@
 
 
-  ///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 

lemon/eps.h

@@ -206 +206 @@
     ///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.
@@ -223 +223 @@
 
     ///Stroke (draw) a path.
-    ///\sa collect
+    ///\sa collect()
     ///
     EpsDrawer &stroke();
@@ -229 +229 @@
 
     ///Fill a path.
-    ///\sa collect
+    ///\sa collect()
     ///
     EpsDrawer &fill();
@@ -235 +235 @@
 
     ///Even-odd fill a path.
-    ///\sa collect
+    ///\sa collect()
     ///
     EpsDrawer &eoFill();
@@ -242 +242 @@
     ///This function sets a clipping area. After that, the drawing operations
     ///will affect only this area.
-    ///\sa collect
+    ///\sa collect()
     ///
     EpsDrawer &clip();
@@ -250 +250 @@
     ///After that, the drawing operations
     ///will affect only this area.
-    ///\sa collect
+    ///\sa collect()
     ///
     EpsDrawer &eoClip();