Changeset 1287:984723507b86 in lemon-0.x

Timestamp:

04/01/05 10:47:40 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1720

Message:

New groups called io_group and dimacs_group added

Files:

• doc/groups.dox (modified) (1 diff)
• doc/quicktour.dox (modified) (1 diff)
• src/lemon/dimacs.h (modified) (2 diffs)
• src/lemon/graph_reader.h (modified) (3 diffs)
• src/lemon/graph_to_eps.h (modified) (2 diffs)
• src/lemon/graph_writer.h (modified) (2 diffs)

doc/groups.dox

@@ -103 +103 @@
 
 /**
+@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

doc/quicktour.dox

@@ -121 +121 @@
 \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

src/lemon/dimacs.h

@@ -24 +24 @@
 #include <lemon/invalid.h>
 
-/// \ingroup misc
+/// \ingroup dimacs_group
 /// \file
 /// \brief Dimacs file format reader.
@@ -30 +30 @@
 namespace lemon {
 
-
-  /// \addtogroup misc
+  ///
+  ///@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 dimacs_group
   /// @{
 

src/lemon/graph_reader.h

@@ -15 +15 @@
  */
 
-///\ingroup gio
+///\ingroup io_group
 ///\file
-///\brief Graph reader.
+///\brief Lemon Graph Format reader.
 
 #ifndef LEMON_GRAPH_READER_H
@@ -42 +42 @@
   struct DefaultReaderTraits {
 
-    /// \brief Template class for reading an value.
+   /// \brief Template class for reading an value.
     ///
     /// Template class for reading an value.
@@ -172 +172 @@
   /// \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

src/lemon/graph_to_eps.h

@@ -32 +32 @@
 #include<lemon/bezier.h>
 
-///\ingroup misc
+///\ingroup io_group
 ///\file
 ///\brief Simple graph drawer
@@ -975 +975 @@
 ///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

src/lemon/graph_writer.h

@@ -15 +15 @@
  */
 
-///\ingroup gio
+///\ingroup io_group
 ///\file
-///\brief Graph writer.
+///\brief Lemon Graph Format writer.
 
 #ifndef LEMON_GRAPH_WRITER_H
@@ -147 +147 @@
   /// \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