1.1 --- a/doc/groups.dox Tue Jun 08 22:38:12 2004 +0000
1.2 +++ b/doc/groups.dox Mon Jun 14 08:35:10 2004 +0000
1.3 @@ -1,30 +1,67 @@
1.4 -/// @defgroup datas Data Structures
1.5 -/// This group describes the several graph structures implemented in HugoLib.
1.6 +/**
1.7 +@defgroup datas Data Structures
1.8 +This group describes the several graph structures implemented in HugoLib.
1.9 +*/
1.10
1.11 -/// @defgroup graphs Graph Structures
1.12 -/// @ingroup datas
1.13 -/// This group describes the graph structures implemented in HugoLib.
1.14 +/**
1.15 +@defgroup graphs Graph Structures
1.16 +@ingroup datas
1.17 +\brief Graph structures implemented in Hugo.
1.18
1.19 -/// @defgroup auxdat Auxiliary Data Structures
1.20 -/// @ingroup datas
1.21 -/// This group describes the data structures implemented in HugoLib in
1.22 -/// order to make it easier to implement combinatorial algorithms.
1.23 +Hugolib provides several data structures to meet the diversing requirements
1.24 +of the possible users.
1.25 +In order to save on running time or on memory usage, some structures may
1.26 +fail to provide
1.27 +some graph features like edge or node deletion.
1.28
1.29 -/// @defgroup gwrappers Wrapper Classes for Graphs
1.30 -/// @ingroup graphs
1.31 -/// This group contains several wrapper classes for graphs
1.32 +Hugolib also offers special graphs that cannot be used alone but only
1.33 +in conjunktion with other graph representation. The examples for this are
1.34 +\ref EdgeSet, \ref NodeSet, and the large variety of graph wrappers.
1.35
1.36 -/// @defgroup galgs Graph Algorithms
1.37 -/// This group describes the several graph algorithms implemented in HugoLib.
1.38 +You are free to use the graph structure that fit your requirements
1.39 +the best, most graph algorithms and auxiliary data structures can be used
1.40 +with any graph structures.
1.41 +*/
1.42
1.43 -/// @defgroup misc Miscellaneous Tools
1.44 -/// Here you can find several useful tools for development,
1.45 -/// debugging and testing.
1.46 +/**
1.47 +@defgroup auxdat Auxiliary Data Structures
1.48 +@ingroup datas
1.49 +\brief Some data structures implemented in HugoLib.
1.50
1.51 -/// @defgroup experimental Experimental Structures and Algorithms
1.52 -/// This group contains some Experimental structures and algorithms.
1.53 -/// The stuff here is subject to change.
1.54 +This group describes the data structures implemented in HugoLib in
1.55 +order to make it easier to implement combinatorial algorithms.
1.56 +*/
1.57
1.58 +/**
1.59 +@defgroup gwrappers Wrapper Classes for Graphs
1.60 +\brief This group contains several wrapper classes for graphs
1.61 +@ingroup graphs
1.62 +*/
1.63 +
1.64 +/**
1.65 +@defgroup galgs Graph Algorithms
1.66 +\brief This group describes the several graph algorithms
1.67 +implemented in HugoLib.
1.68 +*/
1.69 +
1.70 +/**
1.71 +@defgroup spantree Minimum Cost Spanning Tree Algorithms
1.72 +\brief This group containes the algorithms for finding a minimum cost spanning
1.73 +tree in a graph
1.74 +@ingroup galgs
1.75 +*/
1.76 +
1.77 +/**
1.78 +@defgroup misc Miscellaneous Tools
1.79 +Here you can find several useful tools for development,
1.80 +debugging and testing.
1.81 +*/
1.82 +
1.83 +/**
1.84 +@defgroup experimental Experimental Structures and Algorithms
1.85 +This group contains some Experimental structures and algorithms.
1.86 +The stuff here is subject to change.
1.87 +*/
1.88
1.89 /// \ingroup misc experimental
1.90 namespace hugo { }
2.1 --- a/doc/mainpage.dox Tue Jun 08 22:38:12 2004 +0000
2.2 +++ b/doc/mainpage.dox Mon Jun 14 08:35:10 2004 +0000
2.3 @@ -14,14 +14,17 @@
2.4
2.5 \subsection howtoread How to read this document
2.6
2.7 -If you are new to HugoLib, you probably should start \ref graphs "here".
2.8 -You can also find this page along with other under Related Pages (left-hand
2.9 +Graph structures play central role in HugoLib, so if you are new to it,
2.10 +you probably should start \ref graphs "here".
2.11 +You can also find this page along with others under
2.12 +<a href="pages.html"> Related Pages </a>
2.13 +(left-hand
2.14 side frame).
2.15
2.16 If you are more
2.17 interested in details about data structures and algorithms then
2.18 you should browse the reference manual part of the documentation.
2.19 -The Modules
2.20 -section is a good starting point for this.
2.21 +Section <a href="modules.html"> Modules </a>
2.22 + is a good starting point for this.
2.23
2.24 */