[Lemon-commits] [lemon_svn] alpar: r1088 - in hugo/trunk: doc src/hugo/skeletons

[Lemon SVN]

Author: alpar
Date: Fri Sep  3 12:28:21 2004
New Revision: 1088

Modified:
   hugo/trunk/doc/groups.dox
   hugo/trunk/src/hugo/skeletons/graph.h
   hugo/trunk/src/hugo/skeletons/maps.h

Log:
New doxygen module "skeletons" for the skeletons.

Modified: hugo/trunk/doc/groups.dox
==============================================================================
--- hugo/trunk/doc/groups.dox	(original)
+++ hugo/trunk/doc/groups.dox	Fri Sep  3 12:28:21 2004
@@ -67,6 +67,16 @@
 */
 
 /**
+ at 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.
 The stuff here is subject to change.

Modified: hugo/trunk/src/hugo/skeletons/graph.h
==============================================================================
--- hugo/trunk/src/hugo/skeletons/graph.h	(original)
+++ hugo/trunk/src/hugo/skeletons/graph.h	Fri Sep  3 12:28:21 2004
@@ -2,6 +2,7 @@
 #ifndef HUGO_SKELETON_GRAPH_H
 #define HUGO_SKELETON_GRAPH_H
 
+///\ingroup skeletons
 ///\file
 ///\brief Declaration of GraphSkeleton.
 
@@ -12,8 +13,8 @@
 namespace hugo {
   namespace skeleton {
     
-    // @defgroup empty_graph The GraphSkeleton class
-    // @{
+    /// \addtogroup skeletons
+    /// @{
 
     /// An empty static graph class.
   

Modified: hugo/trunk/src/hugo/skeletons/maps.h
==============================================================================
--- hugo/trunk/src/hugo/skeletons/maps.h	(original)
+++ hugo/trunk/src/hugo/skeletons/maps.h	Fri Sep  3 12:28:21 2004
@@ -2,6 +2,7 @@
 #ifndef HUGO_MAPSKELETON_H
 #define HUGO_MAPSKELETON_H
 
+///\ingroup skeletons
 ///\file
 ///\brief Map concepts checking classes for testing and documenting.
 
@@ -10,6 +11,9 @@
   /// The namespace of HUGOlib concepts and concept checking classes
   namespace skeleton {
   
+    /// \addtogroup skeletons
+    /// @{
+
     /// Readable map concept
     template<typename K, typename T>
     class ReadMap
@@ -94,6 +98,9 @@
       ///Default constructor
       ReferenceMap() {}
     };
+
+    // @}
+
   } //namespace skeleton
 } //namespace hugo
 #endif // HUGO_MAPSKELETON_H