COIN-OR::LEMON - Graph Library

Ticket #167: dimacs_0a3ec097a76c.patch

File dimacs_0a3ec097a76c.patch, 3.3 KB (added by Peter Kovacs, 11 years ago)

Doc improvements

  • doc/groups.dox

    # HG changeset patch
    # User Peter Kovacs <kpeter@inf.elte.hu>
    # Date 1227868011 -3600
    # Node ID 0a3ec097a76cbf1145826cc6481087773f218fa8
    # Parent  24a2c6ee6cb04d24d69e375f14f02d547266f53c
    Doc improvements for the DIMACS tools (#167)
    The doc group is moved to groups.dox.
    
    diff --git a/doc/groups.dox b/doc/groups.dox
    a b  
    482482*/
    483483
    484484/**
     485@defgroup dimacs_group DIMACS format
     486@ingroup io_group
     487\brief Read and write files in DIMACS format
     488
     489Tools to read a digraph from or write it to a file in DIMACS format data.
     490*/
     491
     492/**
    485493@defgroup nauty_group NAUTY Format
    486494@ingroup io_group
    487495\brief Read \e Nauty format
     496
    488497Tool to read graphs from \e Nauty format data.
    489498*/
    490499
  • lemon/dimacs.h

    diff --git a/lemon/dimacs.h b/lemon/dimacs.h
    a b  
    3131
    3232namespace lemon {
    3333
    34   ///@defgroup dimacs_group DIMACS format
    35   ///\brief Read and write files in DIMACS format
    36   ///
    37   ///Tools to read a digraph from or write it to a file in DIMACS format
    38   ///data
    39   ///\ingroup io_group
    40 
    4134  /// \addtogroup dimacs_group
    4235  /// @{
    43 
    4436
    4537  /// DIMACS file type descriptor.
    4638  struct DimacsDescriptor
     
    5244      };
    5345    ///The file type
    5446    Type type;
    55     ///The number of nodes on the graph
     47    ///The number of nodes in the graph
    5648    int nodeNum;
    57     ///The number of edges on the graph
     49    ///The number of edges in the graph
    5850    int edgeNum;
    5951    int lineShift;
    6052    /// Constructor. Sets the type to NONE.
     
    6456  ///Discover the type of a DIMACS file
    6557
    6658  ///It starts seeking the begining of the file for the problem type
    67   ///and size info. The found date is returned in a special struct
     59  ///and size info. The found data is returned in a special struct
    6860  ///that can be evaluated and passed to the appropriate reader
    6961  ///function.
    7062  DimacsDescriptor dimacsType(std::istream& is)
     
    10597
    10698
    10799
    108   /// DIMACS min cost flow reader function.
     100  /// DIMACS minimum cost flow reader function.
    109101  ///
    110   /// This function reads a min cost flow instance from DIMACS format,
    111   /// i.e. from DIMACS files having a line starting with
     102  /// This function reads a minimum cost flow instance from DIMACS format,
     103  /// i.e. from a DIMACS file having a line starting with
    112104  /// \code
    113105  ///   p min
    114106  /// \endcode
     
    230222    }
    231223  }
    232224
    233   /// DIMACS max flow reader function.
     225  /// DIMACS maximum flow reader function.
    234226  ///
    235   /// This function reads a max flow instance from DIMACS format,
    236   /// i.e. from DIMACS files having a line starting with
     227  /// This function reads a maximum flow instance from DIMACS format,
     228  /// i.e. from a DIMACS file having a line starting with
    237229  /// \code
    238230  ///   p max
    239231  /// \endcode
     
    259251  /// DIMACS shortest path reader function.
    260252  ///
    261253  /// This function reads a shortest path instance from DIMACS format,
    262   /// i.e. from DIMACS files having a line starting with
     254  /// i.e. from a DIMACS file having a line starting with
    263255  /// \code
    264256  ///   p sp
    265257  /// \endcode
    266258  /// At the beginning, \c g is cleared by \c g.clear(). The arc
    267   /// lengths are written to \c lenght and \c s is set to the
     259  /// lengths are written to \c length and \c s is set to the
    268260  /// source node.
    269261  ///
    270262  /// If the file type was previously evaluated by dimacsType(), then