Changeset 911:89a4fbb99cad in lemon-0.x for src/hugo/preflow.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/preflow.h (modified) (6 diffs)

src/hugo/preflow.h

@@ -45 +45 @@
   ///setFlow.
   ///
-  ///After running \ref phase1() or \ref preflow(), the actual flow
+  ///After running \ref hugo::Preflow::phase1() "phase1()"
+  ///or \ref hugo::Preflow::run() "run()", the actual flow
   ///value can be obtained by calling \ref flowValue(). The minimum
   ///value cut can be written into a <tt>bool</tt> node map by
@@ -97 +98 @@
     ///- \c PRE_FLOW: any preflow, i.e. the sum of the in-flows is at 
     ///least the sum of the out-flows in every node except the \e source.
-    ///- \c NO_FLOW: indicates an unspecified edge map. \ref flow will be 
-    ///set to the constant zero flow in the beginning of the algorithm in this case.
+    ///- \c NO_FLOW: indicates an unspecified edge map. \c flow will be 
+    ///set to the constant zero flow in the beginning of
+    ///the algorithm in this case.
     ///
     enum FlowEnum{
@@ -195 +197 @@
     ///minimum value cut can already be computed, though a maximum flow
     ///is not yet obtained. So after calling this method \ref flowValue
-    ///and \ref actMinCut gives proper results.
-    ///\warning \ref minCut, \ref minMinCut and \ref maxMinCut do not
-    ///give minimum value cuts unless calling \ref phase2.
+    ///and \ref MinCut() gives proper results.
+    ///\warning \ref minCut(), \ref minMinCut() and \ref maxMinCut() do not
+    ///give minimum value cuts unless calling \ref phase2().
     void phase1()
     {
@@ -350 +352 @@
 
     /// Returns the value of the maximum flow by returning the excess
-    /// of the target node \ref t. This value equals to the value of
+    /// of the target node \c t. This value equals to the value of
     /// the maximum flow already after running \ref phase1.
     Num flowValue() const {
@@ -363 +365 @@
     ///phase1 and \ref phase2. It is much faster after
     ///\ref phase1.  \pre M should be a bool-valued node-map. \pre
-    ///If \ref mincut is called after \ref phase2 then M should
+    ///If \ref minCut() is called after \ref phase2() then M should
     ///be initialized to false.
     template<typename _CutMap>
@@ -426 +428 @@
     ///which is inclusionwise maximum. It is computed by processing a
     ///backward bfs from the target node \c t in the residual graph.
-    ///\pre \ref phase2() or preflow() should already be run.
+    ///\pre \ref phase2() or run() should already be run.
     template<typename _CutMap>
     void maxMinCut(_CutMap& M) const {