Moved to subgroup
authordeba
Sat, 14 May 2005 17:22:27 +0000
changeset 14152a5810c2f806
parent 1414 01d9d6bc1284
child 1416 1b481ced25e7
Moved to subgroup
src/lemon/bits/item_reader.h
src/lemon/bits/item_writer.h
     1.1 --- a/src/lemon/bits/item_reader.h	Sat May 14 17:20:40 2005 +0000
     1.2 +++ b/src/lemon/bits/item_reader.h	Sat May 14 17:22:27 2005 +0000
     1.3 @@ -14,7 +14,15 @@
     1.4   *
     1.5   */
     1.6  
     1.7 -/// \ingroup io_group
     1.8 +/// @defgroup item_io Item Readers and Writers
     1.9 +/// @ingroup io_group
    1.10 +/// \brief Item Readers and Writers
    1.11 +/// 
    1.12 +/// The Input-Output classes can handle more data type by example
    1.13 +/// as map or attribute value. Each of these should be written and
    1.14 +/// read some way. The module make possible to do this.  
    1.15 +
    1.16 +/// \ingroup item_io
    1.17  /// \file
    1.18  /// \brief Item reader bits for lemon input.
    1.19  
    1.20 @@ -34,7 +42,7 @@
    1.21    template <typename Value>
    1.22    class DefaultReader;
    1.23  
    1.24 -  /// \ingroup io_group
    1.25 +  /// \ingroup item_io
    1.26    ///
    1.27    /// \brief Reader class for quoted strings.
    1.28    ///
    1.29 @@ -149,7 +157,7 @@
    1.30      bool escaped;
    1.31    };
    1.32  
    1.33 -  /// \ingroup io_group
    1.34 +  /// \ingroup item_io
    1.35    /// \brief Reader for standard containers.
    1.36    ///
    1.37    /// Reader for back insertable standard containers. The representation
    1.38 @@ -191,7 +199,7 @@
    1.39  
    1.40    };
    1.41  
    1.42 -  /// \ingroup io_group
    1.43 +  /// \ingroup item_io
    1.44    ///
    1.45    /// \brief Reader for standard containers.
    1.46    ///
    1.47 @@ -234,7 +242,7 @@
    1.48  
    1.49    };
    1.50  
    1.51 -  /// \ingroup io_group
    1.52 +  /// \ingroup item_io
    1.53    /// \brief Reader for parsed string.
    1.54    ///
    1.55    /// Reader for parsed strings. You can give the open and close
    1.56 @@ -281,7 +289,7 @@
    1.57  
    1.58    };
    1.59  
    1.60 -  /// \ingroup io_group
    1.61 +  /// \ingroup item_io
    1.62    /// \brief Reader for read the whole line.
    1.63    ///
    1.64    /// Reader for read the whole line.
    1.65 @@ -311,7 +319,7 @@
    1.66      bool skipSpaces;
    1.67    };
    1.68  
    1.69 -  /// \ingroup io_group
    1.70 +  /// \ingroup item_io
    1.71    /// 
    1.72    /// \brief The default item reader template class.
    1.73    ///
    1.74 @@ -353,7 +361,13 @@
    1.75    class DefaultReader<std::multiset<Item> > 
    1.76      : public InsertReader<std::multiset<Item> > {};
    1.77  
    1.78 -  /// \ingroup io_group
    1.79 +  /// \ingroup item_io
    1.80 +  /// 
    1.81 +  /// \brief The default item reader for skipping a value in the stream.
    1.82 +  ///
    1.83 +  /// The default item reader for skipping a value in the stream.
    1.84 +  ///
    1.85 +  /// \author Balazs Dezso
    1.86    class DefaultSkipper {
    1.87    public:
    1.88      typedef std::string Value;
    1.89 @@ -375,7 +389,8 @@
    1.90        }
    1.91      }
    1.92    };
    1.93 -  
    1.94 +
    1.95 +  /// \ingroup item_io  
    1.96    /// \brief Standard ReaderTraits for the GraphReader class.
    1.97    ///
    1.98    /// Standard ReaderTraits for the GraphReader class.
     2.1 --- a/src/lemon/bits/item_writer.h	Sat May 14 17:20:40 2005 +0000
     2.2 +++ b/src/lemon/bits/item_writer.h	Sat May 14 17:22:27 2005 +0000
     2.3 @@ -14,7 +14,7 @@
     2.4   *
     2.5   */
     2.6  
     2.7 -/// \ingroup io_group
     2.8 +/// \ingroup item_io
     2.9  /// \file
    2.10  /// \brief Item writer bits for lemon output.
    2.11  
    2.12 @@ -34,7 +34,7 @@
    2.13    template <typename Value>
    2.14    class DefaultWriter;
    2.15  
    2.16 -  /// \ingroup io_group
    2.17 +  /// \ingroup item_io
    2.18    /// \brief Writer class for quoted strings.
    2.19    ///
    2.20    /// Writer class for quoted strings. It can process the escape
    2.21 @@ -117,7 +117,7 @@
    2.22      bool escaped;
    2.23    };
    2.24  
    2.25 -  /// \ingroup io_group
    2.26 +  /// \ingroup item_io
    2.27    ///
    2.28    /// \brief Writer for standard containers.
    2.29    ///
    2.30 @@ -156,7 +156,7 @@
    2.31  
    2.32    };
    2.33  
    2.34 -  /// \ingroup io_group
    2.35 +  /// \ingroup item_io
    2.36    /// 
    2.37    /// \brief The default item writer template class.
    2.38    ///
    2.39 @@ -197,6 +197,7 @@
    2.40    class DefaultWriter<std::multiset<Item> > 
    2.41      : public IterableWriter<std::multiset<Item> > {};
    2.42  
    2.43 +  /// \ingroup item_io
    2.44    /// \brief Standard WriterTraits for the section writers.
    2.45    ///
    2.46    /// Standard WriterTraits for the section writers.