doc/groups.dox
 branch 1.0 changeset 327 12626fc94ccf parent 325 3a2e0692eaae parent 314 2cc60866a0c9 child 329 2592532ee838
     1.1 --- a/doc/groups.dox	Thu Oct 09 13:52:01 2008 +0100
1.2 +++ b/doc/groups.dox	Thu Oct 09 14:37:44 2008 +0100
1.3 @@ -42,7 +42,9 @@
1.4
1.5  You are free to use the graph structure that fit your requirements
1.6  the best, most graph algorithms and auxiliary data structures can be used
1.7 -with any graph structures.
1.8 +with any graph structure.
1.9 +
1.11  */
1.12
1.13  /**
1.14 @@ -52,8 +54,10 @@
1.15
1.16  This group describes the map structures implemented in LEMON.
1.17
1.18 -LEMON provides several special purpose maps that e.g. combine
1.19 +LEMON provides several special purpose maps and map adaptors that e.g. combine
1.20  new maps from existing ones.
1.21 +
1.23  */
1.24
1.25  /**
1.26 @@ -65,7 +69,6 @@
1.27  values to the nodes and arcs of graphs.
1.28  */
1.29
1.30 -
1.31  /**
1.33  \ingroup maps
1.34 @@ -82,7 +85,7 @@
1.35  The typical usage of this classes is passing implicit maps to
1.36  algorithms.  If a function type algorithm is called then the function
1.37  type map adaptors can be used comfortable. For example let's see the
1.38 -usage of map adaptors with the \c digraphToEps() function.
1.39 +usage of map adaptors with the \c graphToEps() function.
1.40  \code
1.41    Color nodeColor(int deg) {
1.42      if (deg >= 2) {
1.43 @@ -96,13 +99,13 @@
1.44
1.45    Digraph::NodeMap<int> degree_map(graph);
1.46
1.47 -  digraphToEps(graph, "graph.eps")
1.48 +  graphToEps(graph, "graph.eps")
1.49      .coords(coords).scaleToA4().undirected()
1.50      .nodeColors(composeMap(functorToMap(nodeColor), degree_map))
1.51      .run();
1.52  \endcode
1.53  The \c functorToMap() function makes an \c int to \c Color map from the
1.54 -\e nodeColor() function. The \c composeMap() compose the \e degree_map
1.55 +\c nodeColor() function. The \c composeMap() compose the \c degree_map
1.56  and the previously created map. The composed map is a proper function to
1.57  get the color of each node.
1.58
1.59 @@ -143,7 +146,6 @@
1.60  any kind of path structure.
1.61
1.62  \sa lemon::concepts::Path
1.63 -
1.64  */
1.65
1.66  /**
1.67 @@ -155,7 +157,6 @@
1.68  order to make it easier to implement combinatorial algorithms.
1.69  */
1.70
1.71 -
1.72  /**
1.73  @defgroup algs Algorithms
1.74  \brief This group describes the several algorithms
1.75 @@ -171,11 +172,11 @@
1.76  \brief Common graph search algorithms.
1.77
1.78  This group describes the common graph search algorithms like
1.79 -Breadth-first search (Bfs) and Depth-first search (Dfs).
1.80 +Breadth-First Search (BFS) and Depth-First Search (DFS).
1.81  */
1.82
1.83  /**
1.84 -@defgroup shortest_path Shortest Path algorithms
1.85 +@defgroup shortest_path Shortest Path Algorithms
1.86  @ingroup algs
1.87  \brief Algorithms for finding shortest paths.
1.88
1.89 @@ -183,7 +184,7 @@
1.90  */
1.91
1.92  /**
1.93 -@defgroup spantree Minimum Spanning Tree algorithms
1.94 +@defgroup spantree Minimum Spanning Tree Algorithms
1.95  @ingroup algs
1.96  \brief Algorithms for finding a minimum cost spanning tree in a graph.
1.97
1.98 @@ -191,6 +192,7 @@
1.99  tree in a graph
1.100  */
1.101
1.102 +@ingroup algs
1.103  /**
1.104  @defgroup utils Tools and Utilities
1.105  \brief Tools and utilities for programming in LEMON
1.106 @@ -216,7 +218,7 @@
1.107  */
1.108
1.109  /**
1.110 -@defgroup timecount Time measuring and Counting
1.111 +@defgroup timecount Time Measuring and Counting
1.112  @ingroup misc
1.113  \brief Simple tools for measuring the performance of algorithms.
1.114
1.115 @@ -239,19 +241,20 @@
1.116  This group describes the tools for importing and exporting graphs
1.117  and graph related data. Now it supports the LEMON format
1.118  and the encapsulated postscript (EPS) format.
1.119 +postscript (EPS) format.
1.120  */
1.121
1.122  /**
1.123  @defgroup lemon_io LEMON Input-Output
1.124  @ingroup io_group
1.125 -\brief Reading and writing \ref lgf-format "LEMON Graph Format".
1.126 +\brief Reading and writing LEMON Graph Format.
1.127
1.128  This group describes methods for reading and writing
1.129  \ref lgf-format "LEMON Graph Format".
1.130  */
1.131
1.132  /**
1.133 -@defgroup eps_io Postscript exporting
1.134 +@defgroup eps_io Postscript Exporting
1.135  @ingroup io_group
1.136  \brief General \c EPS drawer and graph exporter
1.137
1.138 @@ -259,7 +262,6 @@
1.139  graph exporting tools.
1.140  */
1.141
1.142 -
1.143  /**
1.144  @defgroup concept Concepts
1.145  \brief Skeleton classes and concept checking classes
1.146 @@ -287,10 +289,8 @@
1.147    concept indeed provides all the required features.
1.148
1.149  - Finally, They can serve as a skeleton of a new implementation of a concept.
1.150 -
1.151  */
1.152
1.153 -
1.154  /**
1.155  @defgroup graph_concepts Graph Structure Concepts
1.156  @ingroup concept
1.157 @@ -300,6 +300,8 @@
1.158  graph structures and helper classes used to implement these.
1.159  */
1.160
1.161 +
1.162 +This group describes the skeletons and concept checking classes of maps.
1.163  /**
1.164  \anchor demoprograms
1.165