# HG changeset patch # User klao # Date 1083001155 0 # Node ID a677104e946a248670f81e417397000cd4e4b14e # Parent 675bfb074509bcd048f1208e823cd363b19d4092 Minor doc corrections diff -r 675bfb074509 -r a677104e946a src/include/dimacs.h --- a/src/include/dimacs.h Mon Apr 26 17:36:49 2004 +0000 +++ b/src/include/dimacs.h Mon Apr 26 17:39:15 2004 +0000 @@ -6,17 +6,19 @@ #include #include +/// \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 void readDimacsMaxFlow(std::istream& is, Graph &g, typename Graph::Node &s, typename Graph::Node &t, CapacityMap& capacity) { g.clear();