[Lemon-commits] [lemon_svn] alpar: r926 - hugo/trunk/doc

[Lemon SVN]

Author: alpar
Date: Mon Jun 14 10:35:10 2004
New Revision: 926

Modified:
   hugo/trunk/doc/groups.dox
   hugo/trunk/doc/mainpage.dox

Log:
New group for kruskal
Better links on the main page.


Modified: hugo/trunk/doc/groups.dox
==============================================================================
--- hugo/trunk/doc/groups.dox	(original)
+++ hugo/trunk/doc/groups.dox	Mon Jun 14 10:35:10 2004
@@ -1,30 +1,67 @@
-/// @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 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.
-
-/// @defgroup gwrappers Wrapper Classes for Graphs
-/// @ingroup graphs
-/// This group contains several wrapper classes for graphs
-
-/// @defgroup galgs Graph Algorithms
-/// This group describes the several graph algorithms implemented in HugoLib.
-
-/// @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.
-
+/**
+ at defgroup datas Data Structures
+This group describes the several graph structures implemented in HugoLib.
+*/
+
+/**
+ at defgroup graphs Graph Structures
+ at ingroup datas
+\brief Graph structures implemented in Hugo.
+
+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.
+
+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.
+
+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.
+*/
+
+/**
+ at defgroup auxdat Auxiliary Data Structures
+ at ingroup datas
+\brief Some data structures implemented in HugoLib.
+
+This group describes the data structures implemented in HugoLib in
+order to make it easier to implement combinatorial algorithms.
+*/
+
+/**
+ at defgroup gwrappers Wrapper Classes for Graphs
+\brief This group contains several wrapper classes for graphs
+ at ingroup graphs
+*/
+
+/**
+ at defgroup galgs Graph Algorithms
+\brief This group describes the several graph algorithms
+implemented in HugoLib.
+*/
+
+/**
+ at defgroup spantree Minimum Cost Spanning Tree Algorithms
+\brief This group containes the algorithms for finding a minimum cost spanning
+tree in a graph
+ at ingroup galgs
+*/
+
+/**
+ at defgroup misc Miscellaneous Tools
+Here you can find several useful tools for development,
+debugging and testing.
+*/
+
+/**
+ at 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 { }

Modified: hugo/trunk/doc/mainpage.dox
==============================================================================
--- hugo/trunk/doc/mainpage.dox	(original)
+++ hugo/trunk/doc/mainpage.dox	Mon Jun 14 10:35:10 2004
@@ -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
+<a href="pages.html"> Related Pages </a>
+(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 <a href="modules.html"> Modules </a>
+ is a good starting point for this.
 
 */