Changeset 651:3adf5e2d1e62 in lemon-main

Timestamp:

05/07/09 02:07:59 (16 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Small doc improvements (#257)

Files:

• doc/groups.dox (modified) (2 diffs)
• doc/mainpage.dox (modified) (1 diff)
• lemon/matching.h (modified) (2 diffs)

doc/groups.dox

@@ -336 +336 @@
 In most cases the \ref Preflow "Preflow" algorithm provides the
 fastest method for computing a maximum flow. All implementations
-provides functions to also query the minimum cut, which is the dual
-problem of the maximum flow.
+also provide functions to query the minimum cut, which is the dual
+problem of maximum flow.
+
+\ref Circulation is a preflow push-relabel algorithm implemented directly 
+for finding feasible circulations, which is a somewhat different problem,
+but it is strongly related to maximum flow.
+For more information, see \ref Circulation.
 */
 
@@ -542 +547 @@
 @defgroup spantree Minimum Spanning Tree Algorithms
 @ingroup algs
-\brief Algorithms for finding a minimum cost spanning tree in a graph.
-
-This group contains the algorithms for finding a minimum cost spanning
-tree in a graph.
+\brief Algorithms for finding minimum cost spanning trees and arborescences.
+
+This group contains the algorithms for finding minimum cost spanning
+trees and arborescences.
 */
 

doc/mainpage.dox

@@ -42 +42 @@
 \subsection howtoread How to read the documentation
 
-If you want to get a quick start and see the most important features then
-take a look at our \ref quicktour
-"Quick Tour to LEMON" which will guide you along.
-
-If you already feel like using our library, see the
+If you would like to get to know the library, see
 <a class="el" href="http://lemon.cs.elte.hu/pub/tutorial/">LEMON Tutorial</a>.
 
-If you know what you are looking for then try to find it under the
+If you know what you are looking for, then try to find it under the
 <a class="el" href="modules.html">Modules</a> section.
 

lemon/matching.h

@@ -500 +500 @@
     /// This function runs the original Edmonds' algorithm.
     ///
-    /// \pre \ref Init(), \ref greedyInit() or \ref matchingInit() must be
+    /// \pre \ref init(), \ref greedyInit() or \ref matchingInit() must be
     /// called before using this function.
     void startSparse() {
@@ -519 +519 @@
     /// shrinks, therefore resulting in a faster algorithm for dense graphs.
     ///
-    /// \pre \ref Init(), \ref greedyInit() or \ref matchingInit() must be
+    /// \pre \ref init(), \ref greedyInit() or \ref matchingInit() must be
     /// called before using this function.
     void startDense() {