Changeset 313:64f8f7cc6168 in lemon-1.2 for lemon/dim2.h

Timestamp:

10/09/08 10:09:44 (14 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Fix several doxygen warnings

File:

• lemon/dim2.h (modified) (11 diffs)

lemon/dim2.h

@@ -260 +260 @@
 
 
-  /// Bounding box of plain vectors (\ref Point points).
+  /// Bounding box of plain vectors (points).
 
   /// A class to calculate or store the bounding box of plain vectors
-  /// (\ref Point points).
+  /// (\ref Point "points").
   template<typename T>
   class Box {
@@ -574 +574 @@
   }
 
-  ///Map of x-coordinates of a \ref Point "Point"-map
-
-  ///\ingroup maps
+  ///Map of x-coordinates of a <tt>Point</tt>-map
+
   ///Map of x-coordinates of a \ref Point "Point"-map.
-  ///
+  ///\ingroup maps
   template<class M>
   class XMap
@@ -593 +592 @@
   };
 
-  ///Returns an \ref XMap class
-
-  ///This function just returns an \ref XMap class.
+  ///Returns an XMap class
+
+  ///This function just returns an XMap class.
   ///
   ///\ingroup maps
@@ -611 +610 @@
   }
 
-  ///Constant (read only) version of \ref XMap
-
-  ///\ingroup maps
-  ///Constant (read only) version of \ref XMap
-  ///
+  ///Constant (read only) version of XMap
+
+  ///Constant (read only) version of XMap.
+  ///\ingroup maps
   template<class M>
   class ConstXMap
@@ -629 +627 @@
   };
 
-  ///Returns a \ref ConstXMap class
-
-  ///This function just returns a \ref ConstXMap class.
+  ///Returns a ConstXMap class
+
+  ///This function just returns a ConstXMap class.
   ///
   ///\ingroup maps
@@ -641 +639 @@
   }
 
-  ///Map of y-coordinates of a \ref Point "Point"-map
-
-  ///\ingroup maps
+  ///Map of y-coordinates of a <tt>Point</tt>-map
+
   ///Map of y-coordinates of a \ref Point "Point"-map.
-  ///
+  ///\ingroup maps
   template<class M>
   class YMap
@@ -660 +657 @@
   };
 
-  ///Returns a \ref YMap class
-
-  ///This function just returns a \ref YMap class.
+  ///Returns a YMap class
+
+  ///This function just returns a YMap class.
   ///
   ///\ingroup maps
@@ -678 +675 @@
   }
 
-  ///Constant (read only) version of \ref YMap
-
-  ///\ingroup maps
-  ///Constant (read only) version of \ref YMap
-  ///
+  ///Constant (read only) version of YMap
+
+  ///Constant (read only) version of YMap.
+  ///\ingroup maps
   template<class M>
   class ConstYMap
@@ -696 +692 @@
   };
 
-  ///Returns a \ref ConstYMap class
-
-  ///This function just returns a \ref ConstYMap class.
+  ///Returns a ConstYMap class
+
+  ///This function just returns a ConstYMap class.
   ///
   ///\ingroup maps
@@ -709 +705 @@
 
 
-  ///\brief Map of the \ref Point::normSquare() "normSquare()"
-  ///of a \ref Point "Point"-map
+  ///\brief Map of the normSquare() of a <tt>Point</tt>-map
   ///
   ///Map of the \ref Point::normSquare() "normSquare()"
@@ -728 +723 @@
   };
 
-  ///Returns a \ref NormSquareMap class
-
-  ///This function just returns a \ref NormSquareMap class.
+  ///Returns a NormSquareMap class
+
+  ///This function just returns a NormSquareMap class.
   ///
   ///\ingroup maps