[Lemon-commits] [lemon_svn] deba: r2601 - in hugo/trunk: doc lemon/bits

[Lemon SVN]

Author: deba
Date: Fri Mar  3 13:35:32 2006
New Revision: 2601

Modified:
   hugo/trunk/doc/groups.dox
   hugo/trunk/lemon/bits/alteration_notifier.h
   hugo/trunk/lemon/bits/array_map.h
   hugo/trunk/lemon/bits/default_map.h
   hugo/trunk/lemon/bits/edge_set_extender.h
   hugo/trunk/lemon/bits/graph_adaptor_extender.h
   hugo/trunk/lemon/bits/graph_extender.h
   hugo/trunk/lemon/bits/map_extender.h
   hugo/trunk/lemon/bits/traits.h
   hugo/trunk/lemon/bits/vector_map.h

Log:
Some documentation arrangement modification



Modified: hugo/trunk/doc/groups.dox
==============================================================================
--- hugo/trunk/doc/groups.dox	(original)
+++ hugo/trunk/doc/groups.dox	Fri Mar  3 13:35:32 2006
@@ -91,12 +91,12 @@
 */
 
 /**
- at defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
+ at defgroup graphbits Tools to Make It Easier to Make Graphs
 @ingroup auxdat
-\brief Tools to Make It Easier to Make Graph Maps.
+\brief Tools to Make It Easier to Make Graphs.
 
-This group describes the tools that makes it easier to make graph maps that
-dynamically update with the graph changes.
+This group describes the tools that makes it easier to make graphs and
+the maps that dynamically update with the graph changes.
 */
 
 /**

Modified: hugo/trunk/lemon/bits/alteration_notifier.h
==============================================================================
--- hugo/trunk/lemon/bits/alteration_notifier.h	(original)
+++ hugo/trunk/lemon/bits/alteration_notifier.h	Fri Mar  3 13:35:32 2006
@@ -22,13 +22,13 @@
 #include <vector>
 #include <algorithm>
 
-///\ingroup graphmapfactory
+///\ingroup graphbits
 ///\file
 ///\brief Observer registry for graph alteration observers.
 
 namespace lemon {
 
-  /// \addtogroup graphmapfactory
+  /// \addtogroup graphbits
   /// @{
 
   /// \brief Registry class to register objects observes alterations in 

Modified: hugo/trunk/lemon/bits/array_map.h
==============================================================================
--- hugo/trunk/lemon/bits/array_map.h	(original)
+++ hugo/trunk/lemon/bits/array_map.h	Fri Mar  3 13:35:32 2006
@@ -16,8 +16,8 @@
  *
  */
 
-#ifndef LEMON_ARRAY_MAP_H
-#define LEMON_ARRAY_MAP_H
+#ifndef LEMON_BITS_ARRAY_MAP_H
+#define LEMON_BITS_ARRAY_MAP_H
 
 #include <memory>
 #include <lemon/bits/map_extender.h>
@@ -25,14 +25,14 @@
 #include <lemon/concept_check.h>
 #include <lemon/concept/maps.h>
 
-/// \ingroup graphmapfactory
+/// \ingroup graphbits
 /// \file
 /// \brief Graph maps that construct and destruct
 /// their elements dynamically.
 
 namespace lemon {
 
-  /// \ingroup graphmapfactory
+  /// \ingroup graphbits
   ///
   /// \brief Graph map based on the array storage.
   ///
@@ -304,4 +304,4 @@
 
 }
 
-#endif //LEMON_ARRAY_MAP_H
+#endif 

Modified: hugo/trunk/lemon/bits/default_map.h
==============================================================================
--- hugo/trunk/lemon/bits/default_map.h	(original)
+++ hugo/trunk/lemon/bits/default_map.h	Fri Mar  3 13:35:32 2006
@@ -24,7 +24,7 @@
 #include <lemon/bits/vector_map.h>
 #include <lemon/bits/static_map.h>
 
-///\ingroup graphmapfactory
+///\ingroup graphbits
 ///\file
 ///\brief Graph maps that construct and destruct
 ///their elements dynamically.

Modified: hugo/trunk/lemon/bits/edge_set_extender.h
==============================================================================
--- hugo/trunk/lemon/bits/edge_set_extender.h	(original)
+++ hugo/trunk/lemon/bits/edge_set_extender.h	Fri Mar  3 13:35:32 2006
@@ -16,9 +16,22 @@
  *
  */
 
+#ifndef LEMON_BITS_EDGE_SET_EXTENDER_H
+#define LEMON_BITS_EDGE_SET_EXTENDER_H
 
+#include <lemon/bits/invalid.h>
+#include <lemon/error.h>
+
+#include <lemon/bits/default_map.h>
+
+///\ingroup graphbits
+///\file
+///\brief Extenders for the edge set types
 namespace lemon {
 
+  /// \ingroup graphbits
+  ///
+  /// \brief Extender for the EdgeSets
   template <typename Base>
   class EdgeSetExtender : public Base {
   public:
@@ -259,6 +272,9 @@
   };
 
 
+  /// \ingroup graphbits
+  ///
+  /// \brief Extender for the UEdgeSets
   template <typename Base>
   class UEdgeSetExtender : public Base {
 
@@ -607,4 +623,7 @@
     }
     
   };
+
 }
+
+#endif

Modified: hugo/trunk/lemon/bits/graph_adaptor_extender.h
==============================================================================
--- hugo/trunk/lemon/bits/graph_adaptor_extender.h	(original)
+++ hugo/trunk/lemon/bits/graph_adaptor_extender.h	Fri Mar  3 13:35:32 2006
@@ -16,12 +16,23 @@
  *
  */
 
-#ifndef LEMON_GRAPH_ADAPTOR_EXTENDER_H
-#define LEMON_GRAPH_ADAPTOR_EXTENDER_H
+#ifndef LEMON_BITS_GRAPH_ADAPTOR_EXTENDER_H
+#define LEMON_BITS_GRAPH_ADAPTOR_EXTENDER_H
 
+#include <lemon/bits/invalid.h>
+#include <lemon/error.h>
 
+#include <lemon/bits/default_map.h>
+
+
+///\ingroup graphbits
+///\file
+///\brief Extenders for the graph adaptor types
 namespace lemon {
 
+  /// \ingroup graphbits
+  ///
+  /// \brief Extender for the GraphAdaptors
   template <typename Base>
   class GraphAdaptorExtender : public Base {
   public:
@@ -183,6 +194,9 @@
   };
 
 
+  /// \ingroup graphbits
+  ///
+  /// \brief Extender for the UGraphAdaptors
   template <typename Base> 
   class UGraphAdaptorExtender : public Base {
   public:

Modified: hugo/trunk/lemon/bits/graph_extender.h
==============================================================================
--- hugo/trunk/lemon/bits/graph_extender.h	(original)
+++ hugo/trunk/lemon/bits/graph_extender.h	Fri Mar  3 13:35:32 2006
@@ -16,16 +16,22 @@
  *
  */
 
-#ifndef LEMON_GRAPH_EXTENDER_H
-#define LEMON_GRAPH_EXTENDER_H
+#ifndef LEMON_BITS_GRAPH_EXTENDER_H
+#define LEMON_BITS_GRAPH_EXTENDER_H
 
 #include <lemon/bits/invalid.h>
 #include <lemon/error.h>
 
 #include <lemon/bits/default_map.h>
 
+///\ingroup graphbits
+///\file
+///\brief Extenders for the graph types
 namespace lemon {
 
+  /// \ingroup graphbits
+  ///
+  /// \brief Extender for the Graphs
   template <typename Base>
   class GraphExtender : public Base {
   public:
@@ -320,6 +326,9 @@
     }
   };
 
+  /// \ingroup graphbits
+  ///
+  /// \brief BaseExtender for the UGraphs
   template <typename Base>
   class UGraphBaseExtender : public Base {
 
@@ -560,6 +569,9 @@
   };
 
 
+  /// \ingroup graphbits
+  ///
+  /// \brief Extender for the UGraphs
   template <typename Base> 
   class UGraphExtender : public Base {
   public:
@@ -978,6 +990,9 @@
   };
 
 
+  /// \ingroup graphbits
+  ///
+  /// \brief BaseExtender for the BpUGraphs
   template <typename Base>
   class BpUGraphBaseExtender : public Base {
   public:
@@ -1167,6 +1182,9 @@
     }
   };
 
+  /// \ingroup graphbits
+  ///
+  /// \brief Extender for the BpUGraphs
   template <typename Base>
   class BpUGraphExtender : public Base {
   public:
@@ -1796,4 +1814,4 @@
 
 }
 
-#endif // LEMON_UNDIR_GRAPH_EXTENDER_H
+#endif

Modified: hugo/trunk/lemon/bits/map_extender.h
==============================================================================
--- hugo/trunk/lemon/bits/map_extender.h	(original)
+++ hugo/trunk/lemon/bits/map_extender.h	Fri Mar  3 13:35:32 2006
@@ -28,6 +28,7 @@
 
 namespace lemon {
 
+  /// \ingroup graphbits
   template <typename _Map>
   class IterableMapExtender : public _Map {
   public:

Modified: hugo/trunk/lemon/bits/traits.h
==============================================================================
--- hugo/trunk/lemon/bits/traits.h	(original)
+++ hugo/trunk/lemon/bits/traits.h	Fri Mar  3 13:35:32 2006
@@ -297,4 +297,4 @@
 
 }
 
-#endif // LEMON_MAPS_H
+#endif

Modified: hugo/trunk/lemon/bits/vector_map.h
==============================================================================
--- hugo/trunk/lemon/bits/vector_map.h	(original)
+++ hugo/trunk/lemon/bits/vector_map.h	Fri Mar  3 13:35:32 2006
@@ -28,14 +28,14 @@
 #include <lemon/concept_check.h>
 #include <lemon/concept/maps.h>
 
-/// \ingroup graphmapfactory
+/// \ingroup graphbits
 ///
 ///\file
 ///\brief Vector based graph maps.
 
 namespace lemon {
 
-  /// \ingroup graphmapfactory
+  /// \ingroup graphbits
   ///
   /// \brief Graph map based on the std::vector storage.
   ///