diff --git a/doc/groups.dox b/doc/groups.dox --- a/doc/groups.dox +++ b/doc/groups.dox @@ -42,7 +42,9 @@ 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. + +See also: \ref graph_concepts "Graph Structure Concepts". */ /** @@ -52,8 +54,10 @@ 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. + +See also: \ref map_concepts "Map Concepts". */ /** @@ -65,7 +69,6 @@ values to the nodes and arcs of graphs. */ - /** \defgroup map_adaptors Map Adaptors \ingroup maps @@ -82,7 +85,7 @@ The typical usage of this classes is passing implicit maps to 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) { if (deg >= 2) { @@ -96,13 +99,13 @@ Digraph::NodeMap degree_map(graph); - digraphToEps(graph, "graph.eps") + graphToEps(graph, "graph.eps") .coords(coords).scaleToA4().undirected() .nodeColors(composeMap(functorToMap(nodeColor), degree_map)) .run(); \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. @@ -143,7 +146,6 @@ any kind of path structure. \sa lemon::concepts::Path - */ /** @@ -155,7 +157,6 @@ order to make it easier to implement combinatorial algorithms. */ - /** @defgroup algs Algorithms \brief This group describes the several algorithms @@ -171,11 +172,11 @@ \brief Common graph search algorithms. This group describes the common graph search algorithms like -Breadth-first search (Bfs) and Depth-first search (Dfs). +Breadth-First Search (BFS) and Depth-First Search (DFS). */ /** -@defgroup shortest_path Shortest Path algorithms +@defgroup shortest_path Shortest Path Algorithms @ingroup algs \brief Algorithms for finding shortest paths. @@ -183,7 +184,7 @@ */ /** -@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. @@ -191,6 +192,7 @@ tree in a graph */ +@ingroup algs /** @defgroup utils Tools and Utilities \brief Tools and utilities for programming in LEMON @@ -216,7 +218,7 @@ */ /** -@defgroup timecount Time measuring and Counting +@defgroup timecount Time Measuring and Counting @ingroup misc \brief Simple tools for measuring the performance of algorithms. @@ -239,19 +241,20 @@ This group describes the tools for importing and exporting graphs and graph related data. Now it supports the LEMON format and the encapsulated postscript (EPS) format. +postscript (EPS) format. */ /** @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 \ref lgf-format "LEMON Graph Format". */ /** -@defgroup eps_io Postscript exporting +@defgroup eps_io Postscript Exporting @ingroup io_group \brief General \c EPS drawer and graph exporter @@ -259,7 +262,6 @@ graph exporting tools. */ - /** @defgroup concept Concepts \brief Skeleton classes and concept checking classes @@ -287,10 +289,8 @@ concept indeed provides all the required features. - Finally, They can serve as a skeleton of a new implementation of a concept. - */ - /** @defgroup graph_concepts Graph Structure Concepts @ingroup concept @@ -300,6 +300,8 @@ graph structures and helper classes used to implement these. */ + +This group describes the skeletons and concept checking classes of maps. /** \anchor demoprograms