Some documentation arrangement modification
authordeba
Fri, 03 Mar 2006 12:35:32 +0000
changeset 19965dc13b93f8b4
parent 1995 c1fc2c14a3ae
child 1997 b7a70cdb5520
Some documentation arrangement modification
doc/groups.dox
lemon/bits/alteration_notifier.h
lemon/bits/array_map.h
lemon/bits/default_map.h
lemon/bits/edge_set_extender.h
lemon/bits/graph_adaptor_extender.h
lemon/bits/graph_extender.h
lemon/bits/map_extender.h
lemon/bits/traits.h
lemon/bits/vector_map.h
     1.1 --- a/doc/groups.dox	Thu Mar 02 14:22:03 2006 +0000
     1.2 +++ b/doc/groups.dox	Fri Mar 03 12:35:32 2006 +0000
     1.3 @@ -91,12 +91,12 @@
     1.4  */
     1.5  
     1.6  /**
     1.7 -@defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
     1.8 +@defgroup graphbits Tools to Make It Easier to Make Graphs
     1.9  @ingroup auxdat
    1.10 -\brief Tools to Make It Easier to Make Graph Maps.
    1.11 +\brief Tools to Make It Easier to Make Graphs.
    1.12  
    1.13 -This group describes the tools that makes it easier to make graph maps that
    1.14 -dynamically update with the graph changes.
    1.15 +This group describes the tools that makes it easier to make graphs and
    1.16 +the maps that dynamically update with the graph changes.
    1.17  */
    1.18  
    1.19  /**
     2.1 --- a/lemon/bits/alteration_notifier.h	Thu Mar 02 14:22:03 2006 +0000
     2.2 +++ b/lemon/bits/alteration_notifier.h	Fri Mar 03 12:35:32 2006 +0000
     2.3 @@ -22,13 +22,13 @@
     2.4  #include <vector>
     2.5  #include <algorithm>
     2.6  
     2.7 -///\ingroup graphmapfactory
     2.8 +///\ingroup graphbits
     2.9  ///\file
    2.10  ///\brief Observer registry for graph alteration observers.
    2.11  
    2.12  namespace lemon {
    2.13  
    2.14 -  /// \addtogroup graphmapfactory
    2.15 +  /// \addtogroup graphbits
    2.16    /// @{
    2.17  
    2.18    /// \brief Registry class to register objects observes alterations in 
     3.1 --- a/lemon/bits/array_map.h	Thu Mar 02 14:22:03 2006 +0000
     3.2 +++ b/lemon/bits/array_map.h	Fri Mar 03 12:35:32 2006 +0000
     3.3 @@ -16,8 +16,8 @@
     3.4   *
     3.5   */
     3.6  
     3.7 -#ifndef LEMON_ARRAY_MAP_H
     3.8 -#define LEMON_ARRAY_MAP_H
     3.9 +#ifndef LEMON_BITS_ARRAY_MAP_H
    3.10 +#define LEMON_BITS_ARRAY_MAP_H
    3.11  
    3.12  #include <memory>
    3.13  #include <lemon/bits/map_extender.h>
    3.14 @@ -25,14 +25,14 @@
    3.15  #include <lemon/concept_check.h>
    3.16  #include <lemon/concept/maps.h>
    3.17  
    3.18 -/// \ingroup graphmapfactory
    3.19 +/// \ingroup graphbits
    3.20  /// \file
    3.21  /// \brief Graph maps that construct and destruct
    3.22  /// their elements dynamically.
    3.23  
    3.24  namespace lemon {
    3.25  
    3.26 -  /// \ingroup graphmapfactory
    3.27 +  /// \ingroup graphbits
    3.28    ///
    3.29    /// \brief Graph map based on the array storage.
    3.30    ///
    3.31 @@ -304,4 +304,4 @@
    3.32  
    3.33  }
    3.34  
    3.35 -#endif //LEMON_ARRAY_MAP_H
    3.36 +#endif 
     4.1 --- a/lemon/bits/default_map.h	Thu Mar 02 14:22:03 2006 +0000
     4.2 +++ b/lemon/bits/default_map.h	Fri Mar 03 12:35:32 2006 +0000
     4.3 @@ -24,7 +24,7 @@
     4.4  #include <lemon/bits/vector_map.h>
     4.5  #include <lemon/bits/static_map.h>
     4.6  
     4.7 -///\ingroup graphmapfactory
     4.8 +///\ingroup graphbits
     4.9  ///\file
    4.10  ///\brief Graph maps that construct and destruct
    4.11  ///their elements dynamically.
     5.1 --- a/lemon/bits/edge_set_extender.h	Thu Mar 02 14:22:03 2006 +0000
     5.2 +++ b/lemon/bits/edge_set_extender.h	Fri Mar 03 12:35:32 2006 +0000
     5.3 @@ -16,9 +16,22 @@
     5.4   *
     5.5   */
     5.6  
     5.7 +#ifndef LEMON_BITS_EDGE_SET_EXTENDER_H
     5.8 +#define LEMON_BITS_EDGE_SET_EXTENDER_H
     5.9  
    5.10 +#include <lemon/bits/invalid.h>
    5.11 +#include <lemon/error.h>
    5.12 +
    5.13 +#include <lemon/bits/default_map.h>
    5.14 +
    5.15 +///\ingroup graphbits
    5.16 +///\file
    5.17 +///\brief Extenders for the edge set types
    5.18  namespace lemon {
    5.19  
    5.20 +  /// \ingroup graphbits
    5.21 +  ///
    5.22 +  /// \brief Extender for the EdgeSets
    5.23    template <typename Base>
    5.24    class EdgeSetExtender : public Base {
    5.25    public:
    5.26 @@ -259,6 +272,9 @@
    5.27    };
    5.28  
    5.29  
    5.30 +  /// \ingroup graphbits
    5.31 +  ///
    5.32 +  /// \brief Extender for the UEdgeSets
    5.33    template <typename Base>
    5.34    class UEdgeSetExtender : public Base {
    5.35  
    5.36 @@ -607,4 +623,7 @@
    5.37      }
    5.38      
    5.39    };
    5.40 +
    5.41  }
    5.42 +
    5.43 +#endif
     6.1 --- a/lemon/bits/graph_adaptor_extender.h	Thu Mar 02 14:22:03 2006 +0000
     6.2 +++ b/lemon/bits/graph_adaptor_extender.h	Fri Mar 03 12:35:32 2006 +0000
     6.3 @@ -16,12 +16,23 @@
     6.4   *
     6.5   */
     6.6  
     6.7 -#ifndef LEMON_GRAPH_ADAPTOR_EXTENDER_H
     6.8 -#define LEMON_GRAPH_ADAPTOR_EXTENDER_H
     6.9 +#ifndef LEMON_BITS_GRAPH_ADAPTOR_EXTENDER_H
    6.10 +#define LEMON_BITS_GRAPH_ADAPTOR_EXTENDER_H
    6.11  
    6.12 +#include <lemon/bits/invalid.h>
    6.13 +#include <lemon/error.h>
    6.14  
    6.15 +#include <lemon/bits/default_map.h>
    6.16 +
    6.17 +
    6.18 +///\ingroup graphbits
    6.19 +///\file
    6.20 +///\brief Extenders for the graph adaptor types
    6.21  namespace lemon {
    6.22  
    6.23 +  /// \ingroup graphbits
    6.24 +  ///
    6.25 +  /// \brief Extender for the GraphAdaptors
    6.26    template <typename Base>
    6.27    class GraphAdaptorExtender : public Base {
    6.28    public:
    6.29 @@ -183,6 +194,9 @@
    6.30    };
    6.31  
    6.32  
    6.33 +  /// \ingroup graphbits
    6.34 +  ///
    6.35 +  /// \brief Extender for the UGraphAdaptors
    6.36    template <typename Base> 
    6.37    class UGraphAdaptorExtender : public Base {
    6.38    public:
     7.1 --- a/lemon/bits/graph_extender.h	Thu Mar 02 14:22:03 2006 +0000
     7.2 +++ b/lemon/bits/graph_extender.h	Fri Mar 03 12:35:32 2006 +0000
     7.3 @@ -16,16 +16,22 @@
     7.4   *
     7.5   */
     7.6  
     7.7 -#ifndef LEMON_GRAPH_EXTENDER_H
     7.8 -#define LEMON_GRAPH_EXTENDER_H
     7.9 +#ifndef LEMON_BITS_GRAPH_EXTENDER_H
    7.10 +#define LEMON_BITS_GRAPH_EXTENDER_H
    7.11  
    7.12  #include <lemon/bits/invalid.h>
    7.13  #include <lemon/error.h>
    7.14  
    7.15  #include <lemon/bits/default_map.h>
    7.16  
    7.17 +///\ingroup graphbits
    7.18 +///\file
    7.19 +///\brief Extenders for the graph types
    7.20  namespace lemon {
    7.21  
    7.22 +  /// \ingroup graphbits
    7.23 +  ///
    7.24 +  /// \brief Extender for the Graphs
    7.25    template <typename Base>
    7.26    class GraphExtender : public Base {
    7.27    public:
    7.28 @@ -320,6 +326,9 @@
    7.29      }
    7.30    };
    7.31  
    7.32 +  /// \ingroup graphbits
    7.33 +  ///
    7.34 +  /// \brief BaseExtender for the UGraphs
    7.35    template <typename Base>
    7.36    class UGraphBaseExtender : public Base {
    7.37  
    7.38 @@ -560,6 +569,9 @@
    7.39    };
    7.40  
    7.41  
    7.42 +  /// \ingroup graphbits
    7.43 +  ///
    7.44 +  /// \brief Extender for the UGraphs
    7.45    template <typename Base> 
    7.46    class UGraphExtender : public Base {
    7.47    public:
    7.48 @@ -978,6 +990,9 @@
    7.49    };
    7.50  
    7.51  
    7.52 +  /// \ingroup graphbits
    7.53 +  ///
    7.54 +  /// \brief BaseExtender for the BpUGraphs
    7.55    template <typename Base>
    7.56    class BpUGraphBaseExtender : public Base {
    7.57    public:
    7.58 @@ -1167,6 +1182,9 @@
    7.59      }
    7.60    };
    7.61  
    7.62 +  /// \ingroup graphbits
    7.63 +  ///
    7.64 +  /// \brief Extender for the BpUGraphs
    7.65    template <typename Base>
    7.66    class BpUGraphExtender : public Base {
    7.67    public:
    7.68 @@ -1796,4 +1814,4 @@
    7.69  
    7.70  }
    7.71  
    7.72 -#endif // LEMON_UNDIR_GRAPH_EXTENDER_H
    7.73 +#endif
     8.1 --- a/lemon/bits/map_extender.h	Thu Mar 02 14:22:03 2006 +0000
     8.2 +++ b/lemon/bits/map_extender.h	Fri Mar 03 12:35:32 2006 +0000
     8.3 @@ -28,6 +28,7 @@
     8.4  
     8.5  namespace lemon {
     8.6  
     8.7 +  /// \ingroup graphbits
     8.8    template <typename _Map>
     8.9    class IterableMapExtender : public _Map {
    8.10    public:
     9.1 --- a/lemon/bits/traits.h	Thu Mar 02 14:22:03 2006 +0000
     9.2 +++ b/lemon/bits/traits.h	Fri Mar 03 12:35:32 2006 +0000
     9.3 @@ -297,4 +297,4 @@
     9.4  
     9.5  }
     9.6  
     9.7 -#endif // LEMON_MAPS_H
     9.8 +#endif
    10.1 --- a/lemon/bits/vector_map.h	Thu Mar 02 14:22:03 2006 +0000
    10.2 +++ b/lemon/bits/vector_map.h	Fri Mar 03 12:35:32 2006 +0000
    10.3 @@ -28,14 +28,14 @@
    10.4  #include <lemon/concept_check.h>
    10.5  #include <lemon/concept/maps.h>
    10.6  
    10.7 -/// \ingroup graphmapfactory
    10.8 +/// \ingroup graphbits
    10.9  ///
   10.10  ///\file
   10.11  ///\brief Vector based graph maps.
   10.12  
   10.13  namespace lemon {
   10.14  
   10.15 -  /// \ingroup graphmapfactory
   10.16 +  /// \ingroup graphbits
   10.17    ///
   10.18    /// \brief Graph map based on the std::vector storage.
   10.19    ///