author Peter Kovacs Fri, 24 Jul 2009 11:07:52 +0200 changeset 761 98a30824fe36 parent 760 4ac30454f1c1 child 762 ece80147fb08
Rearrange modules (#303)
 doc/groups.dox file | annotate | diff | comparison | revisions lemon/dim2.h file | annotate | diff | comparison | revisions
1.1 --- a/doc/groups.dox	Fri Jul 24 10:27:40 2009 +0200
1.2 +++ b/doc/groups.dox	Fri Jul 24 11:07:52 2009 +0200
1.3 @@ -226,14 +226,6 @@
1.4  */
1.6  /**
1.7 -@defgroup matrices Matrices
1.8 -@ingroup datas
1.9 -\brief Two dimensional data storages implemented in LEMON.
1.10 -
1.11 -This group contains two dimensional data storages implemented in LEMON.
1.12 -*/
1.13 -
1.14 -/**
1.15  @defgroup paths Path Structures
1.16  @ingroup datas
1.17  \brief %Path structures implemented in LEMON.
1.18 @@ -259,6 +251,28 @@
1.19  */
1.21  /**
1.22 +@defgroup geomdat Geometric Data Structures
1.23 +@ingroup auxdat
1.24 +\brief Geometric data structures implemented in LEMON.
1.25 +
1.26 +This group contains geometric data structures implemented in LEMON.
1.27 +
1.28 + - \ref lemon::dim2::Point "dim2::Point" implements a two dimensional
1.29 +   vector with the usual operations.
1.30 + - \ref lemon::dim2::Box "dim2::Box" can be used to determine the
1.31 +   rectangular bounding box of a set of \ref lemon::dim2::Point
1.32 +   "dim2::Point"'s.
1.33 +*/
1.34 +
1.35 +/**
1.36 +@defgroup matrices Matrices
1.37 +@ingroup auxdat
1.38 +\brief Two dimensional data storages implemented in LEMON.
1.39 +
1.40 +This group contains two dimensional data storages implemented in LEMON.
1.41 +*/
1.42 +
1.43 +/**
1.44  @defgroup algs Algorithms
1.45  \brief This group contains the several algorithms
1.46  implemented in LEMON.
1.47 @@ -298,6 +312,15 @@
1.48  */
1.50  /**
1.51 +@defgroup spantree Minimum Spanning Tree Algorithms
1.52 +@ingroup algs
1.53 +\brief Algorithms for finding minimum cost spanning trees and arborescences.
1.54 +
1.55 +This group contains the algorithms for finding minimum cost spanning
1.56 +trees and arborescences.
1.57 +*/
1.58 +
1.59 +/**
1.60  @defgroup max_flow Maximum Flow Algorithms
1.61  @ingroup algs
1.62  \brief Algorithms for finding maximum flows.
1.63 @@ -391,30 +414,6 @@
1.64  */
1.66  /**
1.67 -@defgroup graph_properties Connectivity and Other Graph Properties
1.68 -@ingroup algs
1.69 -\brief Algorithms for discovering the graph properties
1.70 -
1.71 -This group contains the algorithms for discovering the graph properties
1.72 -like connectivity, bipartiteness, euler property, simplicity etc.
1.73 -
1.74 -\image html connected_components.png
1.75 -\image latex connected_components.eps "Connected components" width=\textwidth
1.76 -*/
1.77 -
1.78 -/**
1.79 -@defgroup planar Planarity Embedding and Drawing
1.80 -@ingroup algs
1.81 -\brief Algorithms for planarity checking, embedding and drawing
1.82 -
1.83 -This group contains the algorithms for planarity checking,
1.84 -embedding and drawing.
1.85 -
1.86 -\image html planar.png
1.87 -\image latex planar.eps "Plane graph" width=\textwidth
1.88 -*/
1.89 -
1.90 -/**
1.91  @defgroup matching Matching Algorithms
1.92  @ingroup algs
1.93  \brief Algorithms for finding matchings in graphs and bipartite graphs.
1.94 @@ -455,12 +454,36 @@
1.95  */
1.97  /**
1.98 -@defgroup spantree Minimum Spanning Tree Algorithms
1.99 +@defgroup graph_properties Connectivity and Other Graph Properties
1.100  @ingroup algs
1.101 -\brief Algorithms for finding minimum cost spanning trees and arborescences.
1.102 +\brief Algorithms for discovering the graph properties
1.104 -This group contains the algorithms for finding minimum cost spanning
1.105 -trees and arborescences.
1.106 +This group contains the algorithms for discovering the graph properties
1.107 +like connectivity, bipartiteness, euler property, simplicity etc.
1.109 +\image html connected_components.png
1.110 +\image latex connected_components.eps "Connected components" width=\textwidth
1.111 +*/
1.113 +/**
1.114 +@defgroup planar Planarity Embedding and Drawing
1.115 +@ingroup algs
1.116 +\brief Algorithms for planarity checking, embedding and drawing
1.118 +This group contains the algorithms for planarity checking,
1.119 +embedding and drawing.
1.121 +\image html planar.png
1.122 +\image latex planar.eps "Plane graph" width=\textwidth
1.123 +*/
1.125 +/**
1.126 +@defgroup approx Approximation Algorithms
1.127 +@ingroup algs
1.128 +\brief Approximation algorithms.
1.130 +This group contains the approximation and heuristic algorithms
1.131 +implemented in LEMON.
1.132  */
1.134  /**
1.135 @@ -473,15 +496,6 @@
1.136  */
1.138  /**
1.139 -@defgroup approx Approximation Algorithms
1.140 -@ingroup algs
1.141 -\brief Approximation algorithms.
1.143 -This group contains the approximation and heuristic algorithms
1.144 -implemented in LEMON.
1.145 -*/
1.147 -/**
1.148  @defgroup gen_opt_group General Optimization Tools
1.149  \brief This group contains some general optimization frameworks
1.150  implemented in LEMON.
1.151 @@ -587,7 +601,7 @@
1.152  */
1.154  /**
1.155 -@defgroup dimacs_group DIMACS format
1.156 +@defgroup dimacs_group DIMACS Format
1.157  @ingroup io_group
1.158  \brief Read and write files in DIMACS format
1.160 @@ -649,6 +663,15 @@
1.161  */
1.163  /**
1.164 +@defgroup tools Standalone Utility Applications
1.166 +Some utility applications are listed here.
1.168 +The standard compilation procedure (<tt>./configure;make</tt>) will compile
1.169 +them, as well.
1.170 +*/
1.172 +/**
1.173  \anchor demoprograms
1.175  @defgroup demos Demo Programs
1.176 @@ -660,13 +683,4 @@
1.177  <tt>make check</tt> commands.
1.178  */
1.180 -/**
1.181 -@defgroup tools Standalone Utility Applications
1.183 -Some utility applications are listed here.
1.185 -The standard compilation procedure (<tt>./configure;make</tt>) will compile
1.186 -them, as well.
1.187 -*/
2.1 --- a/lemon/dim2.h	Fri Jul 24 10:27:40 2009 +0200
2.2 +++ b/lemon/dim2.h	Fri Jul 24 11:07:52 2009 +0200
2.3 @@ -21,16 +21,9 @@
2.5  #include <iostream>
2.7 -///\ingroup misc
2.8 +///\ingroup geomdat
2.9  ///\file
2.10  ///\brief A simple two dimensional vector and a bounding box implementation
2.11 -///
2.12 -/// The class \ref lemon::dim2::Point "dim2::Point" implements
2.13 -/// a two dimensional vector with the usual operations.
2.14 -///
2.15 -/// The class \ref lemon::dim2::Box "dim2::Box" can be used to determine
2.16 -/// the rectangular bounding box of a set of
2.17 -/// \ref lemon::dim2::Point "dim2::Point"'s.
2.19  namespace lemon {
2.21 @@ -40,7 +33,7 @@
2.22    ///tools for handling two dimensional coordinates
2.23    namespace dim2 {
2.25 -  /// \addtogroup misc
2.26 +  /// \addtogroup geomdat
2.27    /// @{
2.29    /// Two dimensional vector (plain vector)