New doxygen module "skeletons" for the skeletons.
authoralpar
Fri, 03 Sep 2004 10:28:21 +0000
changeset 794d9ec436d11fe
parent 793 9cd0aeea47b0
child 795 cfa6c2ea48e5
New doxygen module "skeletons" for the skeletons.
doc/groups.dox
src/hugo/skeletons/graph.h
src/hugo/skeletons/maps.h
     1.1 --- a/doc/groups.dox	Fri Sep 03 09:41:50 2004 +0000
     1.2 +++ b/doc/groups.dox	Fri Sep 03 10:28:21 2004 +0000
     1.3 @@ -67,6 +67,16 @@
     1.4  */
     1.5  
     1.6  /**
     1.7 +@defgroup skeletons Skeletons
     1.8 +\brief Skeletons (a.k.a. concept checking classes)
     1.9 +
    1.10 +This group describes the data/algorithm skeletons implemented in HugoLib in
    1.11 +order to make it easier to check if a certain template class or
    1.12 +template function is correctly implemented.
    1.13 +*/
    1.14 +
    1.15 +
    1.16 +/**
    1.17  @defgroup experimental Experimental Structures and Algorithms
    1.18  This group contains some Experimental structures and algorithms.
    1.19  The stuff here is subject to change.
     2.1 --- a/src/hugo/skeletons/graph.h	Fri Sep 03 09:41:50 2004 +0000
     2.2 +++ b/src/hugo/skeletons/graph.h	Fri Sep 03 10:28:21 2004 +0000
     2.3 @@ -2,6 +2,7 @@
     2.4  #ifndef HUGO_SKELETON_GRAPH_H
     2.5  #define HUGO_SKELETON_GRAPH_H
     2.6  
     2.7 +///\ingroup skeletons
     2.8  ///\file
     2.9  ///\brief Declaration of GraphSkeleton.
    2.10  
    2.11 @@ -12,8 +13,8 @@
    2.12  namespace hugo {
    2.13    namespace skeleton {
    2.14      
    2.15 -    // @defgroup empty_graph The GraphSkeleton class
    2.16 -    // @{
    2.17 +    /// \addtogroup skeletons
    2.18 +    /// @{
    2.19  
    2.20      /// An empty static graph class.
    2.21    
     3.1 --- a/src/hugo/skeletons/maps.h	Fri Sep 03 09:41:50 2004 +0000
     3.2 +++ b/src/hugo/skeletons/maps.h	Fri Sep 03 10:28:21 2004 +0000
     3.3 @@ -2,6 +2,7 @@
     3.4  #ifndef HUGO_MAPSKELETON_H
     3.5  #define HUGO_MAPSKELETON_H
     3.6  
     3.7 +///\ingroup skeletons
     3.8  ///\file
     3.9  ///\brief Map concepts checking classes for testing and documenting.
    3.10  
    3.11 @@ -10,6 +11,9 @@
    3.12    /// The namespace of HUGOlib concepts and concept checking classes
    3.13    namespace skeleton {
    3.14    
    3.15 +    /// \addtogroup skeletons
    3.16 +    /// @{
    3.17 +
    3.18      /// Readable map concept
    3.19      template<typename K, typename T>
    3.20      class ReadMap
    3.21 @@ -94,6 +98,9 @@
    3.22        ///Default constructor
    3.23        ReferenceMap() {}
    3.24      };
    3.25 +
    3.26 +    // @}
    3.27 +
    3.28    } //namespace skeleton
    3.29  } //namespace hugo
    3.30  #endif // HUGO_MAPSKELETON_H