Changeset 427:a677104e946a in lemon-0.x for src/include/dimacs.h

Timestamp:

04/26/04 19:39:15 (20 years ago)

Author:

Mihaly Barasz

Branch:

default

Phase:

public

Convert:

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

Message:

Minor doc corrections

File:

• src/include/dimacs.h (modified) (1 diff)

src/include/dimacs.h

@@ -7 +7 @@
 #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) {