Changeset 678:a6bfd3346245 in lemon-0.x

Timestamp:

06/14/04 10:35:10 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@926

Message:

New group for kruskal
Better links on the main page.

Location:

doc

Files:

• groups.dox (modified) (1 diff)
• mainpage.dox (modified) (2 diffs)

doc/groups.dox

@@ -1 @@
-/// @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

doc/mainpage.dox

@@ -15 +15 @@
 \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).
 
@@ -22 +25 @@
 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.
 
 */