Minor doc corrections
authorklao
Mon, 26 Apr 2004 17:39:15 +0000
changeset 427a677104e946a
parent 426 675bfb074509
child 428 3544872b38c2
Minor doc corrections
src/include/dimacs.h
     1.1 --- a/src/include/dimacs.h	Mon Apr 26 17:36:49 2004 +0000
     1.2 +++ b/src/include/dimacs.h	Mon Apr 26 17:39:15 2004 +0000
     1.3 @@ -6,17 +6,19 @@
     1.4  #include <string>
     1.5  #include <vector>
     1.6  
     1.7 +/// \file \brief Dimacs file format reader.
     1.8 +
     1.9  namespace hugo {
    1.10  
    1.11 -  /// Dimacs flow files.
    1.12 +  /// Dimacs flow file format reader function.
    1.13  
    1.14    /// This function reads a flow instance from dimacs flow format.
    1.15 -  /// At the beginning \c g is destroyed by \c g.clear().
    1.16 -  /// If the data coming from \c is is a max flow innstance, then 
    1.17 -  /// \c s and \t will be respectively the source and target nodes 
    1.18 +  /// At the beginning \c g is cleared by \c g.clear().
    1.19 +  /// If the data coming from \c is is a max flow problem instance, then 
    1.20 +  /// \c s and \c t will be respectively the source and target nodes 
    1.21    /// and \c capacity will contain the edge capacities.
    1.22 -  /// If the data is a shortest path problem then \c s will be the 
    1.23 -  /// source node and \capacity will contain the edge lengths.
    1.24 +  /// If the data is a shortest path problem instance then \c s will be the 
    1.25 +  /// source node and \c capacity will contain the edge lengths.
    1.26    template<typename Graph, typename CapacityMap>
    1.27    void readDimacsMaxFlow(std::istream& is, Graph &g, typename Graph::Node &s, typename Graph::Node &t, CapacityMap& capacity) {
    1.28      g.clear();