[Lemon-commits] [lemon_svn] alpar: r1720 - in hugo/trunk: doc src/lemon

[Lemon SVN]

Author: alpar
Date: Fri Apr  1 10:47:40 2005
New Revision: 1720

Modified:
   hugo/trunk/doc/groups.dox
   hugo/trunk/doc/quicktour.dox
   hugo/trunk/src/lemon/dimacs.h
   hugo/trunk/src/lemon/graph_reader.h
   hugo/trunk/src/lemon/graph_to_eps.h
   hugo/trunk/src/lemon/graph_writer.h

Log:
New groups called io_group and dimacs_group added


Modified: hugo/trunk/doc/groups.dox
==============================================================================
--- hugo/trunk/doc/groups.dox	(original)
+++ hugo/trunk/doc/groups.dox	Fri Apr  1 10:47:40 2005
@@ -102,6 +102,12 @@
 */
 
 /**
+ at defgroup io_group Input Output
+Here you can find tools for imporing and exporting graphs and graph related
+data
+*/
+
+/**
 @defgroup concept Concepts
 \brief Skeleton classes and concept checking classes
 

Modified: hugo/trunk/doc/quicktour.dox
==============================================================================
--- hugo/trunk/doc/quicktour.dox	(original)
+++ hugo/trunk/doc/quicktour.dox	Fri Apr  1 10:47:40 2005
@@ -120,7 +120,7 @@
     std::cout << g.id(s) << std::endl;	
 \endcode
 
-See the whole program in \file dijkstra_demo.cc.
+See the whole program in \ref dijkstra_demo.cc.
 
 The first part of the code is self-explanatory: we build the graph and set the
 length values of the edges. Then we instantiate a member of the Dijkstra class

Modified: hugo/trunk/src/lemon/dimacs.h
==============================================================================
--- hugo/trunk/src/lemon/dimacs.h	(original)
+++ hugo/trunk/src/lemon/dimacs.h	Fri Apr  1 10:47:40 2005
@@ -23,14 +23,21 @@
 #include <lemon/maps.h>
 #include <lemon/invalid.h>
 
-/// \ingroup misc
+/// \ingroup dimacs_group
 /// \file
 /// \brief Dimacs file format reader.
 
 namespace lemon {
 
+  ///
+  ///@defgroup dimacs_group DIMACS format
+  ///\brief Read and write files in DIMACS format
+  ///
+  ///Tools to read a graph from or write it to a file in DIMACS format
+  ///data
+  ///\ingroup io_group
 
-  /// \addtogroup misc
+  /// \addtogroup dimacs_group
   /// @{
 
   /// Dimacs min cost flow reader function.

Modified: hugo/trunk/src/lemon/graph_reader.h
==============================================================================
--- hugo/trunk/src/lemon/graph_reader.h	(original)
+++ hugo/trunk/src/lemon/graph_reader.h	Fri Apr  1 10:47:40 2005
@@ -14,9 +14,9 @@
  *
  */
 
-///\ingroup gio
+///\ingroup io_group
 ///\file
-///\brief Graph reader.
+///\brief Lemon Graph Format reader.
 
 #ifndef LEMON_GRAPH_READER_H
 #define LEMON_GRAPH_READER_H
@@ -41,7 +41,7 @@
   /// It defines standard reading method for all type of value. 
   struct DefaultReaderTraits {
 
-    /// \brief Template class for reading an value.
+   /// \brief Template class for reading an value.
     ///
     /// Template class for reading an value.
     template <typename _Value>
@@ -171,7 +171,10 @@
 
   /// \brief The graph reader class.
   ///
+  /// \ingroup io_group
   /// The reader class for the graph input.
+  /// \see DefaultReaderTraits
+  /// \see QuotedStringReader
   /// \see \ref GraphWriter
   /// \see \ref graph-io-page
   template <typename _Graph, typename _ReaderTraits = DefaultReaderTraits> 

Modified: hugo/trunk/src/lemon/graph_to_eps.h
==============================================================================
--- hugo/trunk/src/lemon/graph_to_eps.h	(original)
+++ hugo/trunk/src/lemon/graph_to_eps.h	Fri Apr  1 10:47:40 2005
@@ -31,7 +31,7 @@
 #include<lemon/maps.h>
 #include<lemon/bezier.h>
 
-///\ingroup misc
+///\ingroup io_group
 ///\file
 ///\brief Simple graph drawer
 ///
@@ -974,7 +974,7 @@
 
 ///Generates an EPS file from a graph
 
-///\ingroup misc
+///\ingroup io_group
 ///Generates an EPS file from a graph.
 ///\param g is a reference to the graph to be printed
 ///\param os is a reference to the output stream.

Modified: hugo/trunk/src/lemon/graph_writer.h
==============================================================================
--- hugo/trunk/src/lemon/graph_writer.h	(original)
+++ hugo/trunk/src/lemon/graph_writer.h	Fri Apr  1 10:47:40 2005
@@ -14,9 +14,9 @@
  *
  */
 
-///\ingroup gio
+///\ingroup io_group
 ///\file
-///\brief Graph writer.
+///\brief Lemon Graph Format writer.
 
 #ifndef LEMON_GRAPH_WRITER_H
 #define LEMON_GRAPH_WRITER_H
@@ -146,7 +146,10 @@
   
   /// \brief The graph writer class.
   ///
+  ///\ingroup io_group
   /// The writer class for the graph output.
+  /// \see DefaultWriterTraits
+  /// \see QuotedStringWriter
   /// \see \ref GraphReader
   /// \see \ref graph-io-page
   template <typename _Graph, typename _WriterTraits = DefaultWriterTraits>