[Lemon-commits] [lemon_svn] alpar: r1018 - in hugo/trunk: doc src/hugo src/work/johanna

[Lemon SVN]

Author: alpar
Date: Thu Aug  5 13:38:26 2004
New Revision: 1018

Modified:
   hugo/trunk/doc/groups.dox
   hugo/trunk/src/hugo/dijkstra.h
   hugo/trunk/src/hugo/max_flow.h
   hugo/trunk/src/hugo/mincostflows.h
   hugo/trunk/src/work/johanna/kruskal.h

Log:
New Doxygen module for path/flow algs.

Modified: hugo/trunk/doc/groups.dox
==============================================================================
--- hugo/trunk/doc/groups.dox	(original)
+++ hugo/trunk/doc/groups.dox	Thu Aug  5 13:38:26 2004
@@ -45,10 +45,10 @@
 */
 
 /**
- at defgroup spantree Minimum Cost Spanning Tree Algorithms
-\brief This group containes the algorithms for finding a minimum cost spanning
-tree in a graph
+ at defgroup flowalgs Path and Flow Algorithms
 @ingroup galgs
+\brief This group describes the algorithms
+for finding paths and flows in graphs.
 */
 
 /**

Modified: hugo/trunk/src/hugo/dijkstra.h
==============================================================================
--- hugo/trunk/src/hugo/dijkstra.h	(original)
+++ hugo/trunk/src/hugo/dijkstra.h	Thu Aug  5 13:38:26 2004
@@ -2,7 +2,7 @@
 #ifndef HUGO_DIJKSTRA_H
 #define HUGO_DIJKSTRA_H
 
-///\ingroup galgs
+///\ingroup flowalgs
 ///\file
 ///\brief Dijkstra algorithm.
 
@@ -11,7 +11,7 @@
 
 namespace hugo {
 
-/// \addtogroup galgs
+/// \addtogroup flowalgs
 /// @{
 
   ///%Dijkstra algorithm class.

Modified: hugo/trunk/src/hugo/max_flow.h
==============================================================================
--- hugo/trunk/src/hugo/max_flow.h	(original)
+++ hugo/trunk/src/hugo/max_flow.h	Thu Aug  5 13:38:26 2004
@@ -10,12 +10,13 @@
 #include <hugo/maps.h>
 
 /// \file
-/// \ingroup galgs
+/// \ingroup flowalgs
 
 namespace hugo {
 
-  /// \addtogroup galgs
-  /// @{                                                                                                                                        
+  /// \addtogroup flowalgs
+  /// @{                                                   
+
   ///Maximum flow algorithms class.
 
   ///This class provides various algorithms for finding a flow of
@@ -26,17 +27,19 @@
   ///functions \ref setSource, \ref setTarget, \ref setCap and
   ///\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
   ///value cut can be written into a \c node map of \c bools by
   ///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,
 	    typename CapMap=typename Graph::template EdgeMap<Num>,

Modified: hugo/trunk/src/hugo/mincostflows.h
==============================================================================
--- hugo/trunk/src/hugo/mincostflows.h	(original)
+++ hugo/trunk/src/hugo/mincostflows.h	Thu Aug  5 13:38:26 2004
@@ -2,7 +2,7 @@
 #ifndef HUGO_MINCOSTFLOWS_H
 #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 
 
@@ -15,7 +15,7 @@
 
 namespace hugo {
 
-/// \addtogroup galgs
+/// \addtogroup flowalgs
 /// @{
 
   ///\brief Implementation of an algorithm for finding a flow of value \c k 

Modified: hugo/trunk/src/work/johanna/kruskal.h
==============================================================================
--- hugo/trunk/src/work/johanna/kruskal.h	(original)
+++ hugo/trunk/src/work/johanna/kruskal.h	Thu Aug  5 13:38:26 2004
@@ -5,11 +5,22 @@
 #include <algorithm>
 #include <hugo/unionfind.h>
 
+/**
+ at defgroup spantree Minimum Cost Spanning Tree Algorithms
+\brief This group containes the algorithms for finding a minimum cost spanning
+tree in a graph
+ at 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.
 
   /// This function runs Kruskal's algorithm to find a minimum cost tree.
@@ -293,6 +304,7 @@
     return kruskal(G, iv, out);
   }
 
+  /// @}
 
 } //namespace hugo