Changeset 430:60e4627e8c74 in lemon-0.x

Timestamp:

04/26/04 20:08:46 (19 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Many new modules (groups) in the documentation.

Files:

• doc/groups.dox (modified) (1 diff)
• src/include/bin_heap.h (modified) (3 diffs)
• src/include/dijkstra.h (modified) (3 diffs)
• src/include/fib_heap.h (modified) (3 diffs)
• src/work/athos/minlengthpaths.h (modified) (3 diffs)

doc/groups.dox

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

src/include/bin_heap.h

@@ -62 +62 @@
 #define BIN_HEAP_HH
 
+///ingroup auxdat
 ///\file
 ///\brief Binary Heap implementation.
@@ -71 +72 @@
 namespace hugo {
 
-  /// A Binary Heap implementation.
+  /// \addtogroup auxdat
+  /// @{
+
+   /// A Binary Heap implementation.
   template <typename Item, typename Prio, typename ItemIntMap,
             typename Compare = std::less<Prio> >
@@ -236 +240 @@
   }
 
+  ///@}
+
 } // namespace hugo
 

src/include/dijkstra.h

@@ -3 +3 @@
 #define HUGO_DIJKSTRA_H
 
+///ingroup galgs
 ///\file
 ///\brief Dijkstra algorithm.
@@ -10 +11 @@
 
 namespace hugo {
+
+/// \addtogroup galgs
+/// @{
 
   ///%Dijkstra algorithm class.
@@ -190 +194 @@
       }
   }
+
+/// @}
   
 } //END OF NAMESPACE HUGO

src/include/fib_heap.h

@@ -4 +4 @@
 #define HUGO_FIB_HEAP_H
 
+///ingroup auxdat
 ///\file
 ///\brief Fibonacci Heap implementation.
@@ -13 +14 @@
 namespace hugo {
   
+  /// \addtogroup auxdat
+  /// @{
+
   /// An implementation of the Fibonacci Heap.
 
@@ -491 +495 @@
   }
   
+  ///@}
+
 } //namespace hugo
 #endif 

src/work/athos/minlengthpaths.h

@@ -3 +3 @@
 #define HUGO_MINLENGTHPATHS_H
 
+///ingroup galgs
 ///\file
 ///\brief An algorithm for finding k paths of minimal total length.
@@ -15 +16 @@
 namespace hugo {
 
-
+/// \addtogroup galgs
+/// @{
 
   ///\brief Implementation of an algorithm for finding k paths between 2 nodes 
@@ -161 +163 @@
   }; //class MinLengthPaths
 
+  ///@}
 
 } //namespace hugo