Changeset 42:3a98515e9bc3 in lemon-main

Timestamp:

01/07/08 19:27:17 (17 years ago)

Author:

Alpar Juttner <alpar@…>

Branch:

default

Phase:

public

Message:

Fix several doxygen warnings

Location:

lemon

Files:

• dim2.h (modified) (5 diffs)
• maps.h (modified) (1 diff)
• tolerance.h (modified) (14 diffs)

lemon/dim2.h

@@ -534 +534 @@
 
 
-  ///Map of x-coordinates of a \ref Point "Point"-map
-
-  ///\ingroup maps
-  ///Map of x-coordinates of a \ref Point "Point"-map.
+  ///Map of x-coordinates of a Point map
+
+  ///\ingroup maps
+  ///Map of x-coordinates of a \ref dim2::Point "Point"-map.
   ///
   template<class M>
@@ -571 +571 @@
   }
 
-  ///Constant (read only) version of \ref XMap
+  ///Constant (read only) version of XMap
 
   ///\ingroup maps
@@ -601 +601 @@
   }
 
-  ///Map of y-coordinates of a \ref Point "Point"-map
+  ///Map of y-coordinates of a Point map
     
   ///\ingroup maps
@@ -638 +638 @@
   }
 
-  ///Constant (read only) version of \ref YMap
+  ///Constant (read only) version of YMap
 
   ///\ingroup maps
@@ -669 +669 @@
 
 
-    ///\brief Map of the \ref Point::normSquare() "normSquare()"
-    ///of a \ref Point "Point"-map
+    ///\brief Map of the normSquare()
+    ///of a Point map
     ///
     ///Map of the \ref Point::normSquare() "normSquare()"

lemon/maps.h

@@ -175 +175 @@
 
     typedef True ReferenceMapTag;
-    ///\e
+    ///Key type
     typedef K Key;
-    ///\e
+    ///Value type
     typedef T Value;
-    ///\e
+    ///Reference Type
     typedef T& Reference;
-    ///\e
+    ///Const reference type
     typedef const T& ConstReference;
 

lemon/tolerance.h

@@ -42 +42 @@
   ///
   ///This is an abstract class, it should be specialized for all numerical
-  ///data types. These specialized classes like \ref Tolerance\<double\>
+  ///data types. These specialized classes like Tolerance<double>
   ///may offer additional tuning parameters.
   ///
@@ -92 +92 @@
 
 
-  ///Float specialization of \ref Tolerance.
-
-  ///Float specialization of \ref Tolerance.
+  ///Float specialization of Tolerance.
+
+  ///Float specialization of Tolerance.
   ///\sa Tolerance
   ///\relates Tolerance
@@ -143 +143 @@
   };
 
-  ///Double specialization of \ref Tolerance.
-
-  ///Double specialization of \ref Tolerance.
+  ///Double specialization of Tolerance.
+
+  ///Double specialization of Tolerance.
   ///\sa Tolerance
   ///\relates Tolerance
@@ -194 +194 @@
   };
 
-  ///Long double specialization of \ref Tolerance.
-
-  ///Long double specialization of \ref Tolerance.
+  ///Long double specialization of Tolerance.
+
+  ///Long double specialization of Tolerance.
   ///\sa Tolerance
   ///\relates Tolerance
@@ -245 +245 @@
   };
 
-  ///Integer specialization of \ref Tolerance.
-
-  ///Integer specialization of \ref Tolerance.
+  ///Integer specialization of Tolerance.
+
+  ///Integer specialization of Tolerance.
   ///\sa Tolerance
   template<>
@@ -257 +257 @@
 
     ///\name Comparisons
-    ///See \ref Tolerance for more details.
+    ///See Tolerance for more details.
 
     ///@{
@@ -278 +278 @@
   };
 
+  ///Unsigned integer specialization of Tolerance.
+
   ///Unsigned integer specialization of \ref Tolerance.
-
-  ///Unsigned integer specialization of \ref Tolerance.
   ///\sa Tolerance
   template<>
@@ -290 +290 @@
 
     ///\name Comparisons
-    ///See \ref Tolerance for more details.
+    ///See Tolerance for more details.
 
     ///@{
@@ -312 +312 @@
   
 
-  ///Long integer specialization of \ref Tolerance.
-
-  ///Long integer specialization of \ref Tolerance.
+  ///Long integer specialization of Tolerance.
+
+  ///Long integer specialization of Tolerance.
   ///\sa Tolerance
   template<>
@@ -324 +324 @@
 
     ///\name Comparisons
-    ///See \ref Tolerance for more details.
+    ///See Tolerance for more details.
 
     ///@{
@@ -345 +345 @@
   };
 
+  ///Unsigned long integer specialization of Tolerance.
+
   ///Unsigned long integer specialization of \ref Tolerance.
-
-  ///Unsigned long integer specialization of \ref Tolerance.
   ///\sa Tolerance
   template<>
@@ -357 +357 @@
 
     ///\name Comparisons
-    ///See \ref Tolerance for more details.
+    ///See Tolerance for more details.
 
     ///@{
@@ -380 +380 @@
 #if defined __GNUC__ && !defined __STRICT_ANSI__
 
-  ///Long long integer specialization of \ref Tolerance.
+  ///Long long integer specialization of Tolerance.
 
   ///Long long integer specialization of \ref Tolerance.
@@ -415 +415 @@
   };
 
-  ///Unsigned long long integer specialization of \ref Tolerance.
+  ///Unsigned long long integer specialization of Tolerance.
 
   ///Unsigned long long integer specialization of \ref Tolerance.