[Lemon-commits] [lemon_svn] deba: r2651 - in hugo/trunk: doc lemon lemon/bits

[Lemon SVN]

Author: deba
Date: Mon Mar 27 10:01:10 2006
New Revision: 2651

Modified:
   hugo/trunk/doc/groups.dox
   hugo/trunk/lemon/bits/item_reader.h
   hugo/trunk/lemon/lemon_reader.h
   hugo/trunk/lemon/lemon_writer.h

Log:
Doc rearrangement
Section readers moved to own group



Modified: hugo/trunk/doc/groups.dox
==============================================================================
--- hugo/trunk/doc/groups.dox	(original)
+++ hugo/trunk/doc/groups.dox	Mon Mar 27 10:01:10 2006
@@ -159,12 +159,31 @@
 */
 
 /**
- at defgroup io_group Input Output
+ at defgroup io_group Input-Output
 Here you can find tools for imporing and exporting graphs and graph related
 data
 */
 
 /**
+ at defgroup section_io Section readers and writers
+ at ingroup io_group
+\brief Section readers and writers for lemon Input-Output.
+
+Here you can find which section readers and writers can attach to
+the LemonReader and LemonWriter.
+*/
+
+/**
+ at defgroup item_io Item Readers and Writers
+ at ingroup io_group
+\brief Item readers and writers for lemon Input-Output.
+
+The Input-Output classes can handle more data type by example
+as map or attribute value. Each of these should be written and
+read some way. The module make possible to do this.  
+*/
+
+/**
 @defgroup concept Concepts
 \brief Skeleton classes and concept checking classes
 

Modified: hugo/trunk/lemon/bits/item_reader.h
==============================================================================
--- hugo/trunk/lemon/bits/item_reader.h	(original)
+++ hugo/trunk/lemon/bits/item_reader.h	Mon Mar 27 10:01:10 2006
@@ -16,14 +16,6 @@
  *
  */
 
-/// @defgroin item_io Item Readers and Writers
-/// @ingroup io_groin
-/// \brief Item Readers and Writers
-/// 
-/// The Input-Output classes can handle more data type by example
-/// as map or attribute value. Each of these should be written and
-/// read some way. The module make possible to do this.  
-
 /// \ingroup item_io
 /// \file
 /// \brief Item reader bits for lemon input.

Modified: hugo/trunk/lemon/lemon_reader.h
==============================================================================
--- hugo/trunk/lemon/lemon_reader.h	(original)
+++ hugo/trunk/lemon/lemon_reader.h	Mon Mar 27 10:01:10 2006
@@ -736,7 +736,7 @@
 
   };
 
-  /// \ingroup io_group
+  /// \ingroup section_io
   /// \brief SectionReader for reading a graph's nodeset.
   ///
   /// The lemon format can store multiple graph nodesets with several maps.
@@ -954,7 +954,7 @@
     std::auto_ptr<_reader_bits::MapInverterBase<Node> > inverter;
   };
 
-  /// \ingroup io_group
+  /// \ingroup section_io
   /// \brief SectionReader for reading a graph's edgeset.
   ///
   /// The lemon format can store multiple graph edgesets with several maps.
@@ -1192,7 +1192,7 @@
     std::auto_ptr<_reader_bits::LabelReaderBase<Node> > nodeLabelReader;
   };
 
-  /// \ingroup io_group
+  /// \ingroup section_io
   /// \brief SectionReader for reading a undirected graph's edgeset.
   ///
   /// The lemon format can store multiple undirected edgesets with several 
@@ -1516,7 +1516,7 @@
     std::auto_ptr<_reader_bits::LabelReaderBase<Node> > nodeLabelReader;
   };
 
-  /// \ingroup io_group
+  /// \ingroup section_io
   /// \brief SectionReader for reading labeled nodes.
   ///
   /// The nodes section's header line is \c \@nodes \c nodes_name, but the
@@ -1630,7 +1630,7 @@
     std::auto_ptr<_reader_bits::LabelReaderBase<Node> > nodeLabelReader;
   };
 
-  /// \ingroup io_group
+  /// \ingroup section_io
   /// \brief SectionReader for reading labeled edges.
   ///
   /// The edges section's header line is \c \@edges \c edges_name, but the
@@ -1743,7 +1743,7 @@
     std::auto_ptr<_reader_bits::LabelReaderBase<Edge> > edgeLabelReader;
   };
 
-  /// \ingroup io_group
+  /// \ingroup section_io
   /// \brief SectionReader for reading labeled undirected edges.
   ///
   /// The undirected edges section's header line is \c \@uedges 
@@ -1900,7 +1900,7 @@
     std::auto_ptr<_reader_bits::LabelReaderBase<Edge> > edgeLabelReader;
   };
 
-  /// \ingroup io_group
+  /// \ingroup section_io
   /// \brief SectionReader for attributes.
   ///
   /// The lemon format can store multiple attribute set. Each set has
@@ -2020,7 +2020,7 @@
     Readers readers;  
   };
 
-  /// \ingroup io_group
+  /// \ingroup section_io
   /// \brief SectionReader for retrieve what is in the file.
   ///
   /// SectionReader for retrieve what is in the file. If you want

Modified: hugo/trunk/lemon/lemon_writer.h
==============================================================================
--- hugo/trunk/lemon/lemon_writer.h	(original)
+++ hugo/trunk/lemon/lemon_writer.h	Mon Mar 27 10:01:10 2006
@@ -372,7 +372,7 @@
 
   };
 
-  /// \ingroup io_group
+  /// \ingroup section_io
   /// \brief SectionWriter for writing a graph's nodeset.
   ///
   /// The lemon format can store multiple graph nodesets with several maps.
@@ -528,7 +528,7 @@
 
   };
 
-  /// \ingroup io_group
+  /// \ingroup section_io
   /// \brief SectionWriter for writing a graph's edgesets.
   ///
   /// The lemon format can store multiple graph edgesets with several maps. 
@@ -706,7 +706,7 @@
     std::auto_ptr<_writer_bits::LabelWriterBase<Node> > nodeLabelWriter;
   };
 
-  /// \ingroup io_group
+  /// \ingroup section_io
   /// \brief SectionWriter for writing a undirected edgeset.
   ///
   /// The lemon format can store multiple undirected edgesets with several 
@@ -936,7 +936,7 @@
     std::auto_ptr<_writer_bits::LabelWriterBase<Node> > nodeLabelWriter;
   };
 
-  /// \ingroup io_group
+  /// \ingroup section_io
   /// \brief SectionWriter for writing named nodes.
   ///
   /// The nodes section's header line is \c \@nodes \c nodes_name, but the
@@ -1018,7 +1018,7 @@
     std::auto_ptr<_writer_bits::LabelWriterBase<Node> > labelWriter;
   };
 
-  /// \ingroup io_group
+  /// \ingroup section_io
   /// \brief SectionWriter for writing named edges.
   ///
   /// The edges section's header line is \c \@edges \c edges_name, but the
@@ -1098,7 +1098,7 @@
     std::auto_ptr<_writer_bits::LabelWriterBase<Edge> > labelWriter;
   };
 
-  /// \ingroup io_group
+  /// \ingroup section_io
   /// \brief SectionWriter for writing named undirected edges.
   ///
   /// The undirected edges section's header line is \c \@uedges 
@@ -1205,7 +1205,7 @@
 
   };
 
-  /// \ingroup io_group
+  /// \ingroup section_io
   /// \brief SectionWriter for attributes.
   ///
   /// The lemon format can store multiple attribute set. Each set has