Changeset 851:209c9d53e195 in lemon-0.x for src/hugo/preflow.h

Timestamp:

09/14/04 12:29:47 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Changes in doc.

File:

• src/hugo/preflow.h (modified) (5 diffs)

src/hugo/preflow.h

@@ -17 +17 @@
   /// @{                                                   
 
-  ///Preflow algorithms class.
+  ///%Preflow algorithms class.
 
   ///This class provides an implementation of the \e preflow \e
   ///algorithm producing a flow of maximum value in a directed
   ///graph. The preflow algorithms are the fastest max flow algorithms
-  ///up-to-date. The \e source node, the \e target node, the \e
+  ///up to now. The \e source node, the \e target node, the \e
   ///capacity of the edges and the \e starting \e flow value of the
   ///edges should be passed to the algorithm through the
@@ -29 +29 @@
   ///setFlow.
   ///
-  ///After running \c phase1 or \c preflow, the actual flow
+  ///After running \ref phase1() or \ref preflow(), the actual flow
   ///value can be obtained by calling \ref flowValue(). The minimum
-  ///value cut can be written into a \c node map of \c bools by
-  ///calling \ref minCut. (\ref minMinCut and \ref maxMinCut writes
+  ///value cut can be written into a <tt>bool</tt> node map by
+  ///calling \ref minCut(). (\ref minMinCut() and \ref maxMinCut() writes
   ///the inclusionwise minimum and maximum of the minimum value cuts,
   ///resp.)
@@ -130 +130 @@
     ///Runs the preflow algorithm.  
 
-    ///Runs the preflow algorithm. 
+    ///Runs the preflow algorithm.
+    ///
     void run() {
       phase1(flow_prop);
@@ -158 +159 @@
     ///is not yet obtained. So after calling this method \ref flowValue
     ///and \ref minCut gives proper results.
-    ///\warning: \ref minMinCut and \ref maxMinCut do not
+    ///\warning \ref minMinCut and \ref maxMinCut do not
     ///give minimum value cuts unless calling \ref phase2.
     ///\pre The starting flow must be
@@ -179 +180 @@
     ///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
+    ///\warning \ref minCut, \ref minMinCut and \ref maxMinCut do not
     ///give minimum value cuts unless calling \ref phase2.
     void phase1()