New groups called io_group and dimacs_group added
authoralpar
Fri, 01 Apr 2005 08:47:40 +0000
changeset 1287984723507b86
parent 1286 692948b894e8
child 1288 6cc7b573b7b5
New groups called io_group and dimacs_group added
doc/groups.dox
doc/quicktour.dox
src/lemon/dimacs.h
src/lemon/graph_reader.h
src/lemon/graph_to_eps.h
src/lemon/graph_writer.h
     1.1 --- a/doc/groups.dox	Fri Apr 01 08:28:51 2005 +0000
     1.2 +++ b/doc/groups.dox	Fri Apr 01 08:47:40 2005 +0000
     1.3 @@ -102,6 +102,12 @@
     1.4  */
     1.5  
     1.6  /**
     1.7 +@defgroup io_group Input Output
     1.8 +Here you can find tools for imporing and exporting graphs and graph related
     1.9 +data
    1.10 +*/
    1.11 +
    1.12 +/**
    1.13  @defgroup concept Concepts
    1.14  \brief Skeleton classes and concept checking classes
    1.15  
     2.1 --- a/doc/quicktour.dox	Fri Apr 01 08:28:51 2005 +0000
     2.2 +++ b/doc/quicktour.dox	Fri Apr 01 08:47:40 2005 +0000
     2.3 @@ -120,7 +120,7 @@
     2.4      std::cout << g.id(s) << std::endl;	
     2.5  \endcode
     2.6  
     2.7 -See the whole program in \file dijkstra_demo.cc.
     2.8 +See the whole program in \ref dijkstra_demo.cc.
     2.9  
    2.10  The first part of the code is self-explanatory: we build the graph and set the
    2.11  length values of the edges. Then we instantiate a member of the Dijkstra class
     3.1 --- a/src/lemon/dimacs.h	Fri Apr 01 08:28:51 2005 +0000
     3.2 +++ b/src/lemon/dimacs.h	Fri Apr 01 08:47:40 2005 +0000
     3.3 @@ -23,14 +23,21 @@
     3.4  #include <lemon/maps.h>
     3.5  #include <lemon/invalid.h>
     3.6  
     3.7 -/// \ingroup misc
     3.8 +/// \ingroup dimacs_group
     3.9  /// \file
    3.10  /// \brief Dimacs file format reader.
    3.11  
    3.12  namespace lemon {
    3.13  
    3.14 +  ///
    3.15 +  ///@defgroup dimacs_group DIMACS format
    3.16 +  ///\brief Read and write files in DIMACS format
    3.17 +  ///
    3.18 +  ///Tools to read a graph from or write it to a file in DIMACS format
    3.19 +  ///data
    3.20 +  ///\ingroup io_group
    3.21  
    3.22 -  /// \addtogroup misc
    3.23 +  /// \addtogroup dimacs_group
    3.24    /// @{
    3.25  
    3.26    /// Dimacs min cost flow reader function.
     4.1 --- a/src/lemon/graph_reader.h	Fri Apr 01 08:28:51 2005 +0000
     4.2 +++ b/src/lemon/graph_reader.h	Fri Apr 01 08:47:40 2005 +0000
     4.3 @@ -14,9 +14,9 @@
     4.4   *
     4.5   */
     4.6  
     4.7 -///\ingroup gio
     4.8 +///\ingroup io_group
     4.9  ///\file
    4.10 -///\brief Graph reader.
    4.11 +///\brief Lemon Graph Format reader.
    4.12  
    4.13  #ifndef LEMON_GRAPH_READER_H
    4.14  #define LEMON_GRAPH_READER_H
    4.15 @@ -41,7 +41,7 @@
    4.16    /// It defines standard reading method for all type of value. 
    4.17    struct DefaultReaderTraits {
    4.18  
    4.19 -    /// \brief Template class for reading an value.
    4.20 +   /// \brief Template class for reading an value.
    4.21      ///
    4.22      /// Template class for reading an value.
    4.23      template <typename _Value>
    4.24 @@ -171,7 +171,10 @@
    4.25  
    4.26    /// \brief The graph reader class.
    4.27    ///
    4.28 +  /// \ingroup io_group
    4.29    /// The reader class for the graph input.
    4.30 +  /// \see DefaultReaderTraits
    4.31 +  /// \see QuotedStringReader
    4.32    /// \see \ref GraphWriter
    4.33    /// \see \ref graph-io-page
    4.34    template <typename _Graph, typename _ReaderTraits = DefaultReaderTraits> 
     5.1 --- a/src/lemon/graph_to_eps.h	Fri Apr 01 08:28:51 2005 +0000
     5.2 +++ b/src/lemon/graph_to_eps.h	Fri Apr 01 08:47:40 2005 +0000
     5.3 @@ -31,7 +31,7 @@
     5.4  #include<lemon/maps.h>
     5.5  #include<lemon/bezier.h>
     5.6  
     5.7 -///\ingroup misc
     5.8 +///\ingroup io_group
     5.9  ///\file
    5.10  ///\brief Simple graph drawer
    5.11  ///
    5.12 @@ -974,7 +974,7 @@
    5.13  
    5.14  ///Generates an EPS file from a graph
    5.15  
    5.16 -///\ingroup misc
    5.17 +///\ingroup io_group
    5.18  ///Generates an EPS file from a graph.
    5.19  ///\param g is a reference to the graph to be printed
    5.20  ///\param os is a reference to the output stream.
     6.1 --- a/src/lemon/graph_writer.h	Fri Apr 01 08:28:51 2005 +0000
     6.2 +++ b/src/lemon/graph_writer.h	Fri Apr 01 08:47:40 2005 +0000
     6.3 @@ -14,9 +14,9 @@
     6.4   *
     6.5   */
     6.6  
     6.7 -///\ingroup gio
     6.8 +///\ingroup io_group
     6.9  ///\file
    6.10 -///\brief Graph writer.
    6.11 +///\brief Lemon Graph Format writer.
    6.12  
    6.13  #ifndef LEMON_GRAPH_WRITER_H
    6.14  #define LEMON_GRAPH_WRITER_H
    6.15 @@ -146,7 +146,10 @@
    6.16    
    6.17    /// \brief The graph writer class.
    6.18    ///
    6.19 +  ///\ingroup io_group
    6.20    /// The writer class for the graph output.
    6.21 +  /// \see DefaultWriterTraits
    6.22 +  /// \see QuotedStringWriter
    6.23    /// \see \ref GraphReader
    6.24    /// \see \ref graph-io-page
    6.25    template <typename _Graph, typename _WriterTraits = DefaultWriterTraits>