Changeset 911:89a4fbb99cad in lemon-0.x for src/hugo/fib_heap.h

Timestamp:

09/28/04 09:00:58 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Fix many doxygen command bugs.

File:

• src/hugo/fib_heap.h (modified) (6 diffs)

src/hugo/fib_heap.h

@@ -36 +36 @@
   ///is a data structure for storing items with specified values called \e
   ///priorities in such a way that finding the item with minimum priority is
-  ///efficient. \ref Compare specifies the ordering of the priorities. In a heap
+  ///efficient. \c Compare specifies the ordering of the priorities. In a heap
   ///one can change the priority of an item, add or erase an item, etc.
   ///
@@ -118 +118 @@
     void push (Item const item, PrioType const value);
     
-    ///Returns the item with minimum priority relative to \ref Compare.
-    
-    /**
-       This method returns the item with minimum priority relative to \ref
+    ///Returns the item with minimum priority relative to \c Compare.
+    
+    /**
+       This method returns the item with minimum priority relative to \c
        Compare.  
        \pre The heap must be nonempty.  
@@ -127 +127 @@
     Item top() const { return container[minimum].name; }
 
-    ///Returns the minimum priority relative to \ref Compare.
-
-    /**
-       It returns the minimum priority relative to \ref Compare.
+    ///Returns the minimum priority relative to \c Compare.
+
+    /**
+       It returns the minimum priority relative to \c Compare.
        \pre The heap must be nonempty.
     */
@@ -156 +156 @@
 
 
-    ///Deletes the item with minimum priority relative to \ref Compare.
-
-    /**
-    This method deletes the item with minimum priority relative to \ref
+    ///Deletes the item with minimum priority relative to \c Compare.
+
+    /**
+    This method deletes the item with minimum priority relative to \c
     Compare from the heap.  
     \pre The heap must be non-empty.  
@@ -178 +178 @@
        This method decreases the priority of \c item to \c value.
        \pre \c item must be stored in the heap with priority at least \c
-       value relative to \ref Compare.
+       value relative to \c Compare.
     */
     void decrease (Item item, PrioType const value); 
@@ -188 +188 @@
        there is no precondition on the priority of \c item, this
        method should be used only if it is indeed necessary to increase
-       (relative to \ref Compare) the priority of \c item, because this
+       (relative to \c Compare) the priority of \c item, because this
        method is inefficient.
     */