Doc rearrangement
authordeba
Mon, 27 Mar 2006 08:01:10 +0000
changeset 2016ecb067198349
parent 2015 5e51c9eb5e83
child 2017 6064fd33807c
Doc rearrangement
Section readers moved to own group
doc/groups.dox
lemon/bits/item_reader.h
lemon/lemon_reader.h
lemon/lemon_writer.h
     1.1 --- a/doc/groups.dox	Fri Mar 24 20:27:42 2006 +0000
     1.2 +++ b/doc/groups.dox	Mon Mar 27 08:01:10 2006 +0000
     1.3 @@ -159,12 +159,31 @@
     1.4  */
     1.5  
     1.6  /**
     1.7 -@defgroup io_group Input Output
     1.8 +@defgroup io_group Input-Output
     1.9  Here you can find tools for imporing and exporting graphs and graph related
    1.10  data
    1.11  */
    1.12  
    1.13  /**
    1.14 +@defgroup section_io Section readers and writers
    1.15 +@ingroup io_group
    1.16 +\brief Section readers and writers for lemon Input-Output.
    1.17 +
    1.18 +Here you can find which section readers and writers can attach to
    1.19 +the LemonReader and LemonWriter.
    1.20 +*/
    1.21 +
    1.22 +/**
    1.23 +@defgroup item_io Item Readers and Writers
    1.24 +@ingroup io_group
    1.25 +\brief Item readers and writers for lemon Input-Output.
    1.26 +
    1.27 +The Input-Output classes can handle more data type by example
    1.28 +as map or attribute value. Each of these should be written and
    1.29 +read some way. The module make possible to do this.  
    1.30 +*/
    1.31 +
    1.32 +/**
    1.33  @defgroup concept Concepts
    1.34  \brief Skeleton classes and concept checking classes
    1.35  
     2.1 --- a/lemon/bits/item_reader.h	Fri Mar 24 20:27:42 2006 +0000
     2.2 +++ b/lemon/bits/item_reader.h	Mon Mar 27 08:01:10 2006 +0000
     2.3 @@ -16,14 +16,6 @@
     2.4   *
     2.5   */
     2.6  
     2.7 -/// @defgroin item_io Item Readers and Writers
     2.8 -/// @ingroup io_groin
     2.9 -/// \brief Item Readers and Writers
    2.10 -/// 
    2.11 -/// The Input-Output classes can handle more data type by example
    2.12 -/// as map or attribute value. Each of these should be written and
    2.13 -/// read some way. The module make possible to do this.  
    2.14 -
    2.15  /// \ingroup item_io
    2.16  /// \file
    2.17  /// \brief Item reader bits for lemon input.
     3.1 --- a/lemon/lemon_reader.h	Fri Mar 24 20:27:42 2006 +0000
     3.2 +++ b/lemon/lemon_reader.h	Mon Mar 27 08:01:10 2006 +0000
     3.3 @@ -736,7 +736,7 @@
     3.4  
     3.5    };
     3.6  
     3.7 -  /// \ingroup io_group
     3.8 +  /// \ingroup section_io
     3.9    /// \brief SectionReader for reading a graph's nodeset.
    3.10    ///
    3.11    /// The lemon format can store multiple graph nodesets with several maps.
    3.12 @@ -954,7 +954,7 @@
    3.13      std::auto_ptr<_reader_bits::MapInverterBase<Node> > inverter;
    3.14    };
    3.15  
    3.16 -  /// \ingroup io_group
    3.17 +  /// \ingroup section_io
    3.18    /// \brief SectionReader for reading a graph's edgeset.
    3.19    ///
    3.20    /// The lemon format can store multiple graph edgesets with several maps.
    3.21 @@ -1192,7 +1192,7 @@
    3.22      std::auto_ptr<_reader_bits::LabelReaderBase<Node> > nodeLabelReader;
    3.23    };
    3.24  
    3.25 -  /// \ingroup io_group
    3.26 +  /// \ingroup section_io
    3.27    /// \brief SectionReader for reading a undirected graph's edgeset.
    3.28    ///
    3.29    /// The lemon format can store multiple undirected edgesets with several 
    3.30 @@ -1516,7 +1516,7 @@
    3.31      std::auto_ptr<_reader_bits::LabelReaderBase<Node> > nodeLabelReader;
    3.32    };
    3.33  
    3.34 -  /// \ingroup io_group
    3.35 +  /// \ingroup section_io
    3.36    /// \brief SectionReader for reading labeled nodes.
    3.37    ///
    3.38    /// The nodes section's header line is \c \@nodes \c nodes_name, but the
    3.39 @@ -1630,7 +1630,7 @@
    3.40      std::auto_ptr<_reader_bits::LabelReaderBase<Node> > nodeLabelReader;
    3.41    };
    3.42  
    3.43 -  /// \ingroup io_group
    3.44 +  /// \ingroup section_io
    3.45    /// \brief SectionReader for reading labeled edges.
    3.46    ///
    3.47    /// The edges section's header line is \c \@edges \c edges_name, but the
    3.48 @@ -1743,7 +1743,7 @@
    3.49      std::auto_ptr<_reader_bits::LabelReaderBase<Edge> > edgeLabelReader;
    3.50    };
    3.51  
    3.52 -  /// \ingroup io_group
    3.53 +  /// \ingroup section_io
    3.54    /// \brief SectionReader for reading labeled undirected edges.
    3.55    ///
    3.56    /// The undirected edges section's header line is \c \@uedges 
    3.57 @@ -1900,7 +1900,7 @@
    3.58      std::auto_ptr<_reader_bits::LabelReaderBase<Edge> > edgeLabelReader;
    3.59    };
    3.60  
    3.61 -  /// \ingroup io_group
    3.62 +  /// \ingroup section_io
    3.63    /// \brief SectionReader for attributes.
    3.64    ///
    3.65    /// The lemon format can store multiple attribute set. Each set has
    3.66 @@ -2020,7 +2020,7 @@
    3.67      Readers readers;  
    3.68    };
    3.69  
    3.70 -  /// \ingroup io_group
    3.71 +  /// \ingroup section_io
    3.72    /// \brief SectionReader for retrieve what is in the file.
    3.73    ///
    3.74    /// SectionReader for retrieve what is in the file. If you want
     4.1 --- a/lemon/lemon_writer.h	Fri Mar 24 20:27:42 2006 +0000
     4.2 +++ b/lemon/lemon_writer.h	Mon Mar 27 08:01:10 2006 +0000
     4.3 @@ -372,7 +372,7 @@
     4.4  
     4.5    };
     4.6  
     4.7 -  /// \ingroup io_group
     4.8 +  /// \ingroup section_io
     4.9    /// \brief SectionWriter for writing a graph's nodeset.
    4.10    ///
    4.11    /// The lemon format can store multiple graph nodesets with several maps.
    4.12 @@ -528,7 +528,7 @@
    4.13  
    4.14    };
    4.15  
    4.16 -  /// \ingroup io_group
    4.17 +  /// \ingroup section_io
    4.18    /// \brief SectionWriter for writing a graph's edgesets.
    4.19    ///
    4.20    /// The lemon format can store multiple graph edgesets with several maps. 
    4.21 @@ -706,7 +706,7 @@
    4.22      std::auto_ptr<_writer_bits::LabelWriterBase<Node> > nodeLabelWriter;
    4.23    };
    4.24  
    4.25 -  /// \ingroup io_group
    4.26 +  /// \ingroup section_io
    4.27    /// \brief SectionWriter for writing a undirected edgeset.
    4.28    ///
    4.29    /// The lemon format can store multiple undirected edgesets with several 
    4.30 @@ -936,7 +936,7 @@
    4.31      std::auto_ptr<_writer_bits::LabelWriterBase<Node> > nodeLabelWriter;
    4.32    };
    4.33  
    4.34 -  /// \ingroup io_group
    4.35 +  /// \ingroup section_io
    4.36    /// \brief SectionWriter for writing named nodes.
    4.37    ///
    4.38    /// The nodes section's header line is \c \@nodes \c nodes_name, but the
    4.39 @@ -1018,7 +1018,7 @@
    4.40      std::auto_ptr<_writer_bits::LabelWriterBase<Node> > labelWriter;
    4.41    };
    4.42  
    4.43 -  /// \ingroup io_group
    4.44 +  /// \ingroup section_io
    4.45    /// \brief SectionWriter for writing named edges.
    4.46    ///
    4.47    /// The edges section's header line is \c \@edges \c edges_name, but the
    4.48 @@ -1098,7 +1098,7 @@
    4.49      std::auto_ptr<_writer_bits::LabelWriterBase<Edge> > labelWriter;
    4.50    };
    4.51  
    4.52 -  /// \ingroup io_group
    4.53 +  /// \ingroup section_io
    4.54    /// \brief SectionWriter for writing named undirected edges.
    4.55    ///
    4.56    /// The undirected edges section's header line is \c \@uedges 
    4.57 @@ -1205,7 +1205,7 @@
    4.58  
    4.59    };
    4.60  
    4.61 -  /// \ingroup io_group
    4.62 +  /// \ingroup section_io
    4.63    /// \brief SectionWriter for attributes.
    4.64    ///
    4.65    /// The lemon format can store multiple attribute set. Each set has