[Lemon-commits] [lemon_svn] klao: r567 - hugo/trunk/src/include

[Lemon SVN]

Author: klao
Date: Mon Apr 26 19:39:15 2004
New Revision: 567

Modified:
   hugo/trunk/src/include/dimacs.h

Log:
Minor doc corrections


Modified: hugo/trunk/src/include/dimacs.h
==============================================================================
--- hugo/trunk/src/include/dimacs.h	(original)
+++ hugo/trunk/src/include/dimacs.h	Mon Apr 26 19:39:15 2004
@@ -6,17 +6,19 @@
 #include <string>
 #include <vector>
 
+/// \file \brief Dimacs file format reader.
+
 namespace hugo {
 
-  /// Dimacs flow files.
+  /// Dimacs flow file format reader function.
 
   /// This function reads a flow instance from dimacs flow format.
-  /// At the beginning \c g is destroyed by \c g.clear().
-  /// If the data coming from \c is is a max flow innstance, then 
-  /// \c s and \t will be respectively the source and target nodes 
+  /// At the beginning \c g is cleared by \c g.clear().
+  /// If the data coming from \c is is a max flow problem instance, then 
+  /// \c s and \c t will be respectively the source and target nodes 
   /// and \c capacity will contain the edge capacities.
-  /// If the data is a shortest path problem then \c s will be the 
-  /// source node and \capacity will contain the edge lengths.
+  /// If the data is a shortest path problem instance then \c s will be the 
+  /// source node and \c capacity will contain the edge lengths.
   template<typename Graph, typename CapacityMap>
   void readDimacsMaxFlow(std::istream& is, Graph &g, typename Graph::Node &s, typename Graph::Node &t, CapacityMap& capacity) {
     g.clear();