# HG changeset patch
# User alpar
# Date 1087202110 0
# Node ID a6bfd334624569937fb97238010d549e5ab16f3d
# Parent af3b5c85a227a57adf6685d0bb6a3ba8d2671e06
New group for kruskal
Better links on the main page.
diff -r af3b5c85a227 -r a6bfd3346245 doc/groups.dox
--- a/doc/groups.dox Tue Jun 08 22:38:12 2004 +0000
+++ b/doc/groups.dox Mon Jun 14 08:35:10 2004 +0000
@@ -1,30 +1,67 @@
-/// @defgroup datas Data Structures
-/// This group describes the several graph structures implemented in HugoLib.
+/**
+@defgroup datas Data Structures
+This group describes the several graph structures implemented in HugoLib.
+*/
-/// @defgroup graphs Graph Structures
-/// @ingroup datas
-/// This group describes the graph structures implemented in HugoLib.
+/**
+@defgroup graphs Graph Structures
+@ingroup datas
+\brief Graph structures implemented in Hugo.
-/// @defgroup auxdat Auxiliary Data Structures
-/// @ingroup datas
-/// This group describes the data structures implemented in HugoLib in
-/// order to make it easier to implement combinatorial algorithms.
+Hugolib provides several data structures to meet the diversing requirements
+of the possible users.
+In order to save on running time or on memory usage, some structures may
+fail to provide
+some graph features like edge or node deletion.
-/// @defgroup gwrappers Wrapper Classes for Graphs
-/// @ingroup graphs
-/// This group contains several wrapper classes for graphs
+Hugolib also offers special graphs that cannot be used alone but only
+in conjunktion with other graph representation. The examples for this are
+\ref EdgeSet, \ref NodeSet, and the large variety of graph wrappers.
-/// @defgroup galgs Graph Algorithms
-/// This group describes the several graph algorithms implemented in HugoLib.
+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.
+*/
-/// @defgroup misc Miscellaneous Tools
-/// Here you can find several useful tools for development,
-/// debugging and testing.
+/**
+@defgroup auxdat Auxiliary Data Structures
+@ingroup datas
+\brief Some data structures implemented in HugoLib.
-/// @defgroup experimental Experimental Structures and Algorithms
-/// This group contains some Experimental structures and algorithms.
-/// The stuff here is subject to change.
+This group describes the data structures implemented in HugoLib in
+order to make it easier to implement combinatorial algorithms.
+*/
+/**
+@defgroup gwrappers Wrapper Classes for Graphs
+\brief This group contains several wrapper classes for graphs
+@ingroup graphs
+*/
+
+/**
+@defgroup galgs Graph Algorithms
+\brief This group describes the several graph algorithms
+implemented in HugoLib.
+*/
+
+/**
+@defgroup spantree Minimum Cost Spanning Tree Algorithms
+\brief This group containes the algorithms for finding a minimum cost spanning
+tree in a graph
+@ingroup galgs
+*/
+
+/**
+@defgroup misc Miscellaneous Tools
+Here you can find several useful tools for development,
+debugging and testing.
+*/
+
+/**
+@defgroup experimental Experimental Structures and Algorithms
+This group contains some Experimental structures and algorithms.
+The stuff here is subject to change.
+*/
/// \ingroup misc experimental
namespace hugo { }
diff -r af3b5c85a227 -r a6bfd3346245 doc/mainpage.dox
--- a/doc/mainpage.dox Tue Jun 08 22:38:12 2004 +0000
+++ b/doc/mainpage.dox Mon Jun 14 08:35:10 2004 +0000
@@ -14,14 +14,17 @@
\subsection howtoread How to read this document
-If you are new to HugoLib, you probably should start \ref graphs "here".
-You can also find this page along with other under Related Pages (left-hand
+Graph structures play central role in HugoLib, so if you are new to it,
+you probably should start \ref graphs "here".
+You can also find this page along with others under
+ Related Pages
+(left-hand
side frame).
If you are more
interested in details about data structures and algorithms then
you should browse the reference manual part of the documentation.
-The Modules
-section is a good starting point for this.
+Section Modules
+ is a good starting point for this.
*/