[Lemon-commits] Peter Kovacs: Fixes in API doc of DIMACS reader ...

[Lemon HG]

details:   http://lemon.cs.elte.hu/hg/lemon/rev/332627dd249e
changeset: 1373:332627dd249e
user:      Peter Kovacs <kpeter [at] inf.elte.hu>
date:      Fri Sep 08 17:04:30 2017 +0200
description:
	Fixes in API doc of DIMACS reader methods

diffstat:

 lemon/dimacs.h |  11 ++++++-----
 1 files changed, 6 insertions(+), 5 deletions(-)

diffs (56 lines):

diff --git a/lemon/dimacs.h b/lemon/dimacs.h
--- a/lemon/dimacs.h
+++ b/lemon/dimacs.h
@@ -25,6 +25,7 @@
 #include <limits>
 #include <lemon/maps.h>
 #include <lemon/error.h>
+
 /// \ingroup dimacs_group
 /// \file
 /// \brief DIMACS file format reader.
@@ -118,7 +119,7 @@
   /// a non-zero value, that value will be used as "infinite".
   ///
   /// If the file type was previously evaluated by dimacsType(), then
-  /// the descriptor struct should be given by the \c dest parameter.
+  /// the descriptor struct should be given by the \c desc parameter.
   template <typename Digraph, typename LowerMap,
             typename CapacityMap, typename CostMap,
             typename SupplyMap>
@@ -272,7 +273,7 @@
   /// a non-zero value, that value will be used as "infinite".
   ///
   /// If the file type was previously evaluated by dimacsType(), then
-  /// the descriptor struct should be given by the \c dest parameter.
+  /// the descriptor struct should be given by the \c desc parameter.
   template<typename Digraph, typename CapacityMap>
   void readDimacsMax(std::istream& is,
                      Digraph &g,
@@ -299,7 +300,7 @@
   /// source node.
   ///
   /// If the file type was previously evaluated by dimacsType(), then
-  /// the descriptor struct should be given by the \c dest parameter.
+  /// the descriptor struct should be given by the \c desc parameter.
   template<typename Digraph, typename LengthMap>
   void readDimacsSp(std::istream& is,
                     Digraph &g,
@@ -330,7 +331,7 @@
   /// a non-zero value, that value will be used as "infinite".
   ///
   /// If the file type was previously evaluated by dimacsType(), then
-  /// the descriptor struct should be given by the \c dest parameter.
+  /// the descriptor struct should be given by the \c desc parameter.
   template<typename Digraph, typename CapacityMap>
   void readDimacsCap(std::istream& is,
                      Digraph &g,
@@ -370,7 +371,7 @@
   /// At the beginning, \c g is cleared by \c g.clear().
   ///
   /// If the file type was previously evaluated by dimacsType(), then
-  /// the descriptor struct should be given by the \c dest parameter.
+  /// the descriptor struct should be given by the \c desc parameter.
   template<typename Graph>
   void readDimacsMat(std::istream& is, Graph &g,
                      DimacsDescriptor desc=DimacsDescriptor())