# HG changeset patch # User alpar # Date 1083002926 0 # Node ID 60e4627e8c7499ab9c13512a89e9792439c60bc5 # Parent 0e83db759894692f2a22a652b5fc1df50ce488a8 Many new modules (groups) in the documentation. diff -r 0e83db759894 -r 60e4627e8c74 doc/groups.dox --- a/doc/groups.dox Mon Apr 26 17:41:23 2004 +0000 +++ b/doc/groups.dox Mon Apr 26 18:08:46 2004 +0000 @@ -1,18 +1,30 @@ -/// @defgroup misc Miscellaneous tools +/// @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 +/// @defgroup experimental Experimental Structures and Algorithms /// This group contains some Experimental structures and algorithms. /// The stuffs here are subject to change. -/// @defgroup gwrappers Wrapper classes for graphs -/// @ingroup experimental -/// This group contains several wrapper classes for graphs - -/// @defgroup graphs Graph structures -/// @ingroup experimental -/// This group describes the several graph structures implemented in HugoLib. /// \ingroup misc experimental namespace hugo { } diff -r 0e83db759894 -r 60e4627e8c74 src/include/bin_heap.h --- a/src/include/bin_heap.h Mon Apr 26 17:41:23 2004 +0000 +++ b/src/include/bin_heap.h Mon Apr 26 18:08:46 2004 +0000 @@ -61,6 +61,7 @@ #ifndef BIN_HEAP_HH #define BIN_HEAP_HH +///ingroup auxdat ///\file ///\brief Binary Heap implementation. @@ -70,7 +71,10 @@ namespace hugo { - /// A Binary Heap implementation. + /// \addtogroup auxdat + /// @{ + + /// A Binary Heap implementation. template > class BinHeap { @@ -235,6 +239,8 @@ return hole; } + ///@} + } // namespace hugo #endif // BIN_HEAP_HH diff -r 0e83db759894 -r 60e4627e8c74 src/include/dijkstra.h --- a/src/include/dijkstra.h Mon Apr 26 17:41:23 2004 +0000 +++ b/src/include/dijkstra.h Mon Apr 26 18:08:46 2004 +0000 @@ -2,6 +2,7 @@ #ifndef HUGO_DIJKSTRA_H #define HUGO_DIJKSTRA_H +///ingroup galgs ///\file ///\brief Dijkstra algorithm. @@ -10,6 +11,9 @@ namespace hugo { +/// \addtogroup galgs +/// @{ + ///%Dijkstra algorithm class. ///This class provides an efficient implementation of %Dijkstra algorithm. @@ -189,6 +193,8 @@ } //FIXME tis bracket } } + +/// @} } //END OF NAMESPACE HUGO diff -r 0e83db759894 -r 60e4627e8c74 src/include/fib_heap.h --- a/src/include/fib_heap.h Mon Apr 26 17:41:23 2004 +0000 +++ b/src/include/fib_heap.h Mon Apr 26 18:08:46 2004 +0000 @@ -3,6 +3,7 @@ #ifndef HUGO_FIB_HEAP_H #define HUGO_FIB_HEAP_H +///ingroup auxdat ///\file ///\brief Fibonacci Heap implementation. @@ -12,6 +13,9 @@ namespace hugo { + /// \addtogroup auxdat + /// @{ + /// An implementation of the Fibonacci Heap. /** @@ -490,5 +494,7 @@ container[rightn].left_neighbor=leftn; } + ///@} + } //namespace hugo #endif diff -r 0e83db759894 -r 60e4627e8c74 src/work/athos/minlengthpaths.h --- a/src/work/athos/minlengthpaths.h Mon Apr 26 17:41:23 2004 +0000 +++ b/src/work/athos/minlengthpaths.h Mon Apr 26 18:08:46 2004 +0000 @@ -2,6 +2,7 @@ #ifndef HUGO_MINLENGTHPATHS_H #define HUGO_MINLENGTHPATHS_H +///ingroup galgs ///\file ///\brief An algorithm for finding k paths of minimal total length. @@ -14,7 +15,8 @@ namespace hugo { - +/// \addtogroup galgs +/// @{ ///\brief Implementation of an algorithm for finding k paths between 2 nodes /// of minimal total length @@ -160,6 +162,7 @@ }; //class MinLengthPaths + ///@} } //namespace hugo