Changeset 785:a9b0863c2265 in lemon-0.x

Timestamp:

09/02/04 17:13:21 (19 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Changes in doc. (New module name for array/vector maps added.)

Files:

• doc/groups.dox (modified) (1 diff)
• src/hugo/array_map_factory.h (modified) (2 diffs)
• src/hugo/dijkstra.h (modified) (4 diffs)
• src/hugo/map_defines.h (modified) (2 diffs)
• src/hugo/map_registry.h (modified) (2 diffs)
• src/hugo/mincostflows.h (modified) (1 diff)
• src/hugo/vector_map_factory.h (modified) (2 diffs)

doc/groups.dox

@@ -34 +34 @@
 
 /**
+@defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps
+@ingroup auxdat
+\brief Tools to Make It Easier to Make Graph Maps.
+
+This group describes the tools that makes it easier to make graph maps that
+dynamically update with the graph changes.
+*/
+
+/**
 @defgroup gwrappers Wrapper Classes for Graphs
 \brief This group contains several wrapper classes for graphs

src/hugo/array_map_factory.h

@@ -7 +7 @@
 #include <hugo/extended_pair.h>
 
+///\ingroup graphmapfactory
+///\file
+///\brief Graph maps that construates and destruates
+///their elements dynamically.
+
 namespace hugo {
         
+/// \addtogroup graphmapfactory
+/// @{
+
+  ///.
   template <typename MapRegistry> class ArrayMapFactory {
                 
@@ -363 +372 @@
     };          
   };
+  
+/// @}
+  
+
 }
 

src/hugo/dijkstra.h

@@ -88 +88 @@
     Node source;
 
-    ///Initialize maps
+    ///Initializes the maps.
     
     ///\todo Error if \c G or are \c NULL. What about \c length?
@@ -133 +133 @@
     ///Sets the graph the algorithm will run on.
     ///\return <tt> (*this) </tt>
+    ///\bug What about maps?
+    ///\todo It may be unnecessary
     Dijkstra &setGraph(const Graph &_G) 
     {
@@ -274 +276 @@
 
     ///For a node \c v it returns the 'previous edge' of the shortest path tree,
-    ///i.e. it returns the last edge from a shortest path from the root to \c
+    ///i.e. it returns the last edge of a shortest path from the root to \c
     ///v. It is \ref INVALID
     ///if \c v is unreachable from the root or if \c v=s. The
@@ -323 +325 @@
   };
   
-
-  // **********************************************************************
-  //  IMPLEMENTATIONS
-  // **********************************************************************
-
 /// @}
   

src/hugo/map_defines.h

@@ -2 +2 @@
 #ifndef MAP_DEFINES_H
 #define MAP_DEFINES_H
+
+///\ingroup graphmapfactory
+///\file
+///\brief Defines to help creating graph maps.
+
+/// \addtogroup graphmapfactory
+/// @{
 
 /** Creates the EdgeMapRegistry type an declare a mutable instance 
@@ -210 +217 @@
     };
 
+  
+/// @}
+  
 #endif

src/hugo/map_registry.h

@@ -5 +5 @@
 #include <vector>
 
+///\ingroup graphmapfactory
+///\file
+///\brief Map registry for graph maps.
+
 using namespace std;
 
 namespace hugo {
+
+/// \addtogroup graphmapfactory
+/// @{
 
 /** 
@@ -262 +269 @@
   };
 
+  
+/// @}
+  
+
 }
 

src/hugo/mincostflows.h

@@ -90 +90 @@
     //To store the flow
     EdgeIntMap flow; 
-    //To store the potentila (dual variables)
+    //To store the potential (dual variables)
     typedef typename Graph::template NodeMap<Length> PotentialMap;
     PotentialMap potential;

src/hugo/vector_map_factory.h

@@ -7 +7 @@
 #include <hugo/extended_pair.h>
 
+///\ingroup graphmapfactory
+///\file
+///\brief Vector based graph maps.
+
 namespace hugo {
-
+  
+  /// \addtogroup graphmapfactory
+  /// @{
+  
   /** The VectorMapFactory template class is a factory class
    *  to create maps for the edge and nodes. This map factory
@@ -334 +341 @@
   };
 
+  
+  /// @}
+  
+
 }