Changeset 388:0a3ec097a76c in lemon-main

Timestamp:

11/28/08 11:26:51 (16 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Doc improvements for the DIMACS tools (#167)
The doc group is moved to groups.dox.

Files:

• doc/groups.dox (modified) (1 diff)
• lemon/dimacs.h (modified) (6 diffs)

doc/groups.dox

@@ -483 +483 @@
 
 /**
+@defgroup dimacs_group DIMACS format
+@ingroup io_group
+\brief Read and write files in DIMACS format
+
+Tools to read a digraph from or write it to a file in DIMACS format data.
+*/
+
+/**
 @defgroup nauty_group NAUTY Format
 @ingroup io_group
 \brief Read \e Nauty format
+
 Tool to read graphs from \e Nauty format data.
 */

lemon/dimacs.h

@@ -32 +32 @@
 namespace lemon {
 
-  ///@defgroup dimacs_group DIMACS format
-  ///\brief Read and write files in DIMACS format
-  ///
-  ///Tools to read a digraph from or write it to a file in DIMACS format
-  ///data
-  ///\ingroup io_group
-
   /// \addtogroup dimacs_group
   /// @{
-
 
   /// DIMACS file type descriptor.
@@ -53 +45 @@
     ///The file type
     Type type;
-    ///The number of nodes on the graph
+    ///The number of nodes in the graph
     int nodeNum;
-    ///The number of edges on the graph
+    ///The number of edges in the graph
     int edgeNum;
     int lineShift;
@@ -65 +57 @@
 
   ///It starts seeking the begining of the file for the problem type
-  ///and size info. The found date is returned in a special struct
+  ///and size info. The found data is returned in a special struct
   ///that can be evaluated and passed to the appropriate reader
   ///function.
@@ -106 +98 @@
 
 
-  /// DIMACS min cost flow reader function.
-  ///
-  /// This function reads a min cost flow instance from DIMACS format,
-  /// i.e. from DIMACS files having a line starting with
+  /// DIMACS minimum cost flow reader function.
+  ///
+  /// This function reads a minimum cost flow instance from DIMACS format,
+  /// i.e. from a DIMACS file having a line starting with
   /// \code
   ///   p min
@@ -231 +223 @@
   }
 
-  /// DIMACS max flow reader function.
-  ///
-  /// This function reads a max flow instance from DIMACS format,
-  /// i.e. from DIMACS files having a line starting with
+  /// DIMACS maximum flow reader function.
+  ///
+  /// This function reads a maximum flow instance from DIMACS format,
+  /// i.e. from a DIMACS file having a line starting with
   /// \code
   ///   p max
@@ -260 +252 @@
   ///
   /// This function reads a shortest path instance from DIMACS format,
-  /// i.e. from DIMACS files having a line starting with
+  /// i.e. from a DIMACS file having a line starting with
   /// \code
   ///   p sp
   /// \endcode
   /// At the beginning, \c g is cleared by \c g.clear(). The arc
-  /// lengths are written to \c lenght and \c s is set to the
+  /// lengths are written to \c length and \c s is set to the
   /// source node.
   ///