Many new modules (groups) in the documentation.
authoralpar
Mon, 26 Apr 2004 18:08:46 +0000
changeset 43060e4627e8c74
parent 429 0e83db759894
child 431 79a5641f2dbc
Many new modules (groups) in the documentation.
doc/groups.dox
src/include/bin_heap.h
src/include/dijkstra.h
src/include/fib_heap.h
src/work/athos/minlengthpaths.h
     1.1 --- a/doc/groups.dox	Mon Apr 26 17:41:23 2004 +0000
     1.2 +++ b/doc/groups.dox	Mon Apr 26 18:08:46 2004 +0000
     1.3 @@ -1,18 +1,30 @@
     1.4 -/// @defgroup misc Miscellaneous tools
     1.5 +/// @defgroup datas Data Structures
     1.6 +/// This group describes the several graph structures implemented in HugoLib.
     1.7 +
     1.8 +/// @defgroup graphs Graph Structures
     1.9 +/// @ingroup datas
    1.10 +/// This group describes the graph structures implemented in HugoLib.
    1.11 +
    1.12 +/// @defgroup auxdat Auxiliary Data Structures
    1.13 +/// @ingroup datas
    1.14 +/// This group describes the data structures implemented in HugoLib in
    1.15 +/// order to make it easier to implement combinatorial algorithms.
    1.16 +
    1.17 +/// @defgroup gwrappers Wrapper Classes for Graphs
    1.18 +/// @ingroup graphs
    1.19 +/// This group contains several wrapper classes for graphs
    1.20 +
    1.21 +/// @defgroup galgs Graph Algorithms
    1.22 +/// This group describes the several graph algorithms implemented in HugoLib.
    1.23 +
    1.24 +/// @defgroup misc Miscellaneous Tools
    1.25  /// Here you can find several useful tools for development,
    1.26  /// debugging and testing.
    1.27  
    1.28 -/// @defgroup experimental Experimental structures and algorithms
    1.29 +/// @defgroup experimental Experimental Structures and Algorithms
    1.30  /// This group contains some Experimental structures and algorithms.
    1.31  /// The stuffs here are subject to change.
    1.32  
    1.33 -/// @defgroup gwrappers Wrapper classes for graphs
    1.34 -/// @ingroup experimental
    1.35 -/// This group contains several wrapper classes for graphs
    1.36 -
    1.37 -/// @defgroup graphs Graph structures
    1.38 -/// @ingroup experimental
    1.39 -/// This group describes the several graph structures implemented in HugoLib.
    1.40  
    1.41  /// \ingroup misc experimental
    1.42  namespace hugo { }
     2.1 --- a/src/include/bin_heap.h	Mon Apr 26 17:41:23 2004 +0000
     2.2 +++ b/src/include/bin_heap.h	Mon Apr 26 18:08:46 2004 +0000
     2.3 @@ -61,6 +61,7 @@
     2.4  #ifndef BIN_HEAP_HH
     2.5  #define BIN_HEAP_HH
     2.6  
     2.7 +///ingroup auxdat
     2.8  ///\file
     2.9  ///\brief Binary Heap implementation.
    2.10  
    2.11 @@ -70,7 +71,10 @@
    2.12  
    2.13  namespace hugo {
    2.14  
    2.15 -  /// A Binary Heap implementation.
    2.16 +  /// \addtogroup auxdat
    2.17 +  /// @{
    2.18 +
    2.19 +   /// A Binary Heap implementation.
    2.20    template <typename Item, typename Prio, typename ItemIntMap,
    2.21  	    typename Compare = std::less<Prio> >
    2.22    class BinHeap {
    2.23 @@ -235,6 +239,8 @@
    2.24      return hole;
    2.25    }
    2.26  
    2.27 +  ///@}
    2.28 +
    2.29  } // namespace hugo
    2.30  
    2.31  #endif // BIN_HEAP_HH
     3.1 --- a/src/include/dijkstra.h	Mon Apr 26 17:41:23 2004 +0000
     3.2 +++ b/src/include/dijkstra.h	Mon Apr 26 18:08:46 2004 +0000
     3.3 @@ -2,6 +2,7 @@
     3.4  #ifndef HUGO_DIJKSTRA_H
     3.5  #define HUGO_DIJKSTRA_H
     3.6  
     3.7 +///ingroup galgs
     3.8  ///\file
     3.9  ///\brief Dijkstra algorithm.
    3.10  
    3.11 @@ -10,6 +11,9 @@
    3.12  
    3.13  namespace hugo {
    3.14  
    3.15 +/// \addtogroup galgs
    3.16 +/// @{
    3.17 +
    3.18    ///%Dijkstra algorithm class.
    3.19  
    3.20    ///This class provides an efficient implementation of %Dijkstra algorithm.
    3.21 @@ -189,6 +193,8 @@
    3.22        } //FIXME tis bracket
    3.23        }
    3.24    }
    3.25 +
    3.26 +/// @}
    3.27    
    3.28  } //END OF NAMESPACE HUGO
    3.29  
     4.1 --- a/src/include/fib_heap.h	Mon Apr 26 17:41:23 2004 +0000
     4.2 +++ b/src/include/fib_heap.h	Mon Apr 26 18:08:46 2004 +0000
     4.3 @@ -3,6 +3,7 @@
     4.4  #ifndef HUGO_FIB_HEAP_H
     4.5  #define HUGO_FIB_HEAP_H
     4.6  
     4.7 +///ingroup auxdat
     4.8  ///\file
     4.9  ///\brief Fibonacci Heap implementation.
    4.10  
    4.11 @@ -12,6 +13,9 @@
    4.12  
    4.13  namespace hugo {
    4.14    
    4.15 +  /// \addtogroup auxdat
    4.16 +  /// @{
    4.17 +
    4.18    /// An implementation of the Fibonacci Heap.
    4.19  
    4.20    /**
    4.21 @@ -490,5 +494,7 @@
    4.22        container[rightn].left_neighbor=leftn;
    4.23    }
    4.24    
    4.25 +  ///@}
    4.26 +
    4.27  } //namespace hugo
    4.28  #endif 
     5.1 --- a/src/work/athos/minlengthpaths.h	Mon Apr 26 17:41:23 2004 +0000
     5.2 +++ b/src/work/athos/minlengthpaths.h	Mon Apr 26 18:08:46 2004 +0000
     5.3 @@ -2,6 +2,7 @@
     5.4  #ifndef HUGO_MINLENGTHPATHS_H
     5.5  #define HUGO_MINLENGTHPATHS_H
     5.6  
     5.7 +///ingroup galgs
     5.8  ///\file
     5.9  ///\brief An algorithm for finding k paths of minimal total length.
    5.10  
    5.11 @@ -14,7 +15,8 @@
    5.12  
    5.13  namespace hugo {
    5.14  
    5.15 -
    5.16 +/// \addtogroup galgs
    5.17 +/// @{
    5.18  
    5.19    ///\brief Implementation of an algorithm for finding k paths between 2 nodes 
    5.20    /// of minimal total length 
    5.21 @@ -160,6 +162,7 @@
    5.22  
    5.23    }; //class MinLengthPaths
    5.24  
    5.25 +  ///@}
    5.26  
    5.27  } //namespace hugo
    5.28