Changes in doc/groups.dox [325:3a2e0692eaae:327:12626fc94ccf] in lemon

File:

• doc/groups.dox (modified) (18 diffs)

doc/groups.dox

@@ -43 +43 @@
 You are free to use the graph structure that fit your requirements
 the best, most graph algorithms and auxiliary data structures can be used
-with any graph structures.
+with any graph structure.
+
+<b>See also:</b> \ref graph_concepts "Graph Structure Concepts".
 */
 
@@ -53 +55 @@
 This group describes the map structures implemented in LEMON.
 
-LEMON provides several special purpose maps that e.g. combine
+LEMON provides several special purpose maps and map adaptors that e.g. combine
 new maps from existing ones.
+
+<b>See also:</b> \ref map_concepts "Map Concepts".
 */
 
@@ -65 +69 @@
 values to the nodes and arcs of graphs.
 */
-
 
 /**
@@ -83 +86 @@
 algorithms.  If a function type algorithm is called then the function
 type map adaptors can be used comfortable. For example let's see the
-usage of map adaptors with the \c digraphToEps() function.
+usage of map adaptors with the \c graphToEps() function.
 \code
   Color nodeColor(int deg) {
@@ -97 +100 @@
   Digraph::NodeMap<int> degree_map(graph);
 
-  digraphToEps(graph, "graph.eps")
+  graphToEps(graph, "graph.eps")
     .coords(coords).scaleToA4().undirected()
     .nodeColors(composeMap(functorToMap(nodeColor), degree_map))
@@ -103 +106 @@
 \endcode
 The \c functorToMap() function makes an \c int to \c Color map from the
-\e nodeColor() function. The \c composeMap() compose the \e degree_map
+\c nodeColor() function. The \c composeMap() compose the \c degree_map
 and the previously created map. The composed map is a proper function to
 get the color of each node.
@@ -144 +147 @@
 
 \sa lemon::concepts::Path
-
 */
 
@@ -156 +158 @@
 */
 
-
 /**
 @defgroup algs Algorithms
@@ -172 +173 @@
 
 This group describes the common graph search algorithms like
-Breadth-first search (Bfs) and Depth-first search (Dfs).
-*/
-
-/**
-@defgroup shortest_path Shortest Path algorithms
+Breadth-First Search (BFS) and Depth-First Search (DFS).
+*/
+
+/**
+@defgroup shortest_path Shortest Path Algorithms
 @ingroup algs
 \brief Algorithms for finding shortest paths.
@@ -184 +185 @@
 
 /**
-@defgroup spantree Minimum Spanning Tree algorithms
+@defgroup spantree Minimum Spanning Tree Algorithms
 @ingroup algs
 \brief Algorithms for finding a minimum cost spanning tree in a graph.
@@ -192 +193 @@
 */
 
+@ingroup algs
 /**
 @defgroup utils Tools and Utilities
@@ -217 +219 @@
 
 /**
-@defgroup timecount Time measuring and Counting
+@defgroup timecount Time Measuring and Counting
 @ingroup misc
 \brief Simple tools for measuring the performance of algorithms.
@@ -240 +242 @@
 and graph related data. Now it supports the LEMON format
 and the encapsulated postscript (EPS) format.
+postscript (EPS) format.
 */
 
@@ -245 +248 @@
 @defgroup lemon_io LEMON Input-Output
 @ingroup io_group
-\brief Reading and writing \ref lgf-format "LEMON Graph Format".
+\brief Reading and writing LEMON Graph Format.
 
 This group describes methods for reading and writing
@@ -252 +255 @@
 
 /**
-@defgroup eps_io Postscript exporting
+@defgroup eps_io Postscript Exporting
 @ingroup io_group
 \brief General \c EPS drawer and graph exporter
@@ -259 +262 @@
 graph exporting tools.
 */
-
 
 /**
@@ -288 +290 @@
 
 - Finally, They can serve as a skeleton of a new implementation of a concept.
-
-*/
-
+*/
 
 /**
@@ -301 +301 @@
 */
 
+
+This group describes the skeletons and concept checking classes of maps.
 /**
 \anchor demoprograms