Changeset 794:d9ec436d11fe in lemon-0.x

Timestamp:

09/03/04 12:28:21 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

New doxygen module "skeletons" for the skeletons.

Files:

• doc/groups.dox (modified) (1 diff)
• src/hugo/skeletons/graph.h (modified) (2 diffs)
• src/hugo/skeletons/maps.h (modified) (3 diffs)

doc/groups.dox

@@ -68 +68 @@
 
 /**
+@defgroup skeletons Skeletons
+\brief Skeletons (a.k.a. concept checking classes)
+
+This group describes the data/algorithm skeletons implemented in HugoLib in
+order to make it easier to check if a certain template class or
+template function is correctly implemented.
+*/
+
+
+/**
 @defgroup experimental Experimental Structures and Algorithms
 This group contains some Experimental structures and algorithms.

src/hugo/skeletons/graph.h

@@ -3 +3 @@
 #define HUGO_SKELETON_GRAPH_H
 
+///\ingroup skeletons
 ///\file
 ///\brief Declaration of GraphSkeleton.
@@ -13 +14 @@
   namespace skeleton {
     
-    // @defgroup empty_graph The GraphSkeleton class
-    // @{
+    /// \addtogroup skeletons
+    /// @{
 
     /// An empty static graph class.

src/hugo/skeletons/maps.h

@@ -3 +3 @@
 #define HUGO_MAPSKELETON_H
 
+///\ingroup skeletons
 ///\file
 ///\brief Map concepts checking classes for testing and documenting.
@@ -11 +12 @@
   namespace skeleton {
   
+    /// \addtogroup skeletons
+    /// @{
+
     /// Readable map concept
     template<typename K, typename T>
@@ -95 +99 @@
       ReferenceMap() {}
     };
+
+    // @}
+
   } //namespace skeleton
 } //namespace hugo