Changeset 758:49b1a30c4dc4 in lemon-0.x

Timestamp:

08/05/04 13:38:26 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

New Doxygen module for path/flow algs.

Files:

• doc/groups.dox (modified) (1 diff)
• src/hugo/dijkstra.h (modified) (2 diffs)
• src/hugo/max_flow.h (modified) (3 diffs)
• src/hugo/mincostflows.h (modified) (2 diffs)
• src/work/johanna/kruskal.h (modified) (2 diffs)

doc/groups.dox

@@ -46 +46 @@
 
 /**
-@defgroup spantree Minimum Cost Spanning Tree Algorithms
-\brief This group containes the algorithms for finding a minimum cost spanning
-tree in a graph
+@defgroup flowalgs Path and Flow Algorithms
 @ingroup galgs
+\brief This group describes the algorithms
+for finding paths and flows in graphs.
 */
 

src/hugo/dijkstra.h

@@ -3 +3 @@
 #define HUGO_DIJKSTRA_H
 
-///\ingroup galgs
+///\ingroup flowalgs
 ///\file
 ///\brief Dijkstra algorithm.
@@ -12 +12 @@
 namespace hugo {
 
-/// \addtogroup galgs
+/// \addtogroup flowalgs
 /// @{
 

src/hugo/max_flow.h

@@ -11 +11 @@
 
 /// \file
-/// \ingroup galgs
+/// \ingroup flowalgs
 
 namespace hugo {
 
-  /// \addtogroup galgs
-  /// @{                                                                                                                                        
+  /// \addtogroup flowalgs
+  /// @{                                                   
+
   ///Maximum flow algorithms class.
 
@@ -27 +28 @@
   ///\ref setFlow. Before any subsequent runs of any algorithm of
   ///the class \ref setFlow should be called. 
-
+  ///
   ///After running an algorithm of the class, the actual flow value 
   ///can be obtained by calling \ref flowValue(). The minimum
@@ -33 +34 @@
   ///calling \ref minCut. (\ref minMinCut and \ref maxMinCut writes
   ///the inclusionwise minimum and maximum of the minimum value
-  ///cuts, resp.)                                                                                                                               
+  ///cuts, resp.)
+  ///
   ///\param Graph The directed graph type the algorithm runs on.
   ///\param Num The number type of the capacities and the flow values.
   ///\param CapMap The capacity map type.
-  ///\param FlowMap The flow map type.                                                                                                           
+  ///\param FlowMap The flow map type.
+  ///
   ///\author Marton Makai, Jacint Szabo 
   template <typename Graph, typename Num,

src/hugo/mincostflows.h

@@ -3 +3 @@
 #define HUGO_MINCOSTFLOWS_H
 
-///\ingroup galgs
+///\ingroup flowalgs
 ///\file
 ///\brief An algorithm for finding a flow of value \c k (for small values of \c k) having minimal total cost 
@@ -16 +16 @@
 namespace hugo {
 
-/// \addtogroup galgs
+/// \addtogroup flowalgs
 /// @{
 

src/work/johanna/kruskal.h

@@ -6 +6 @@
 #include <hugo/unionfind.h>
 
+/**
+@defgroup spantree Minimum Cost Spanning Tree Algorithms
+\brief This group containes the algorithms for finding a minimum cost spanning
+tree in a graph
+@ingroup galgs
+*/
+
+///\ingroup spantree
 ///\file
 ///\brief Kruskal's algorithm to compute a minimum cost tree
 
 namespace hugo {
+
+  /// \addtogroup spantree
+  /// @{
 
   /// Kruskal's algorithm to find a minimum cost tree of a graph.
@@ -294 +305 @@
   }
 
+  /// @}
 
 } //namespace hugo