Changeset 434:1ce1b4cd8dd5 in lemon-0.x for src/work

Timestamp:

04/27/04 10:31:00 (21 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Some more docs.
DirPath::Builder::setFist() added. (It is empty.)

File:

• src/work/klao/path.h (modified) (10 diffs)

src/work/klao/path.h

@@ -1 +1 @@
 // -*- c++ -*- //
 
-/**
- *
- * Class for representing paths in graphs.
- *
- */
+///ingroup datas
+///\file
+///\brief Class for representing paths in graphs.
 
 #ifndef HUGO_PATH_H
@@ -18 +16 @@
 namespace hugo {
 
+  /// \addtogroup datas
+  /// @{
+
+  ///A container for directed paths
+
+  ///\param Graph The graph type in which the path is.
+  ///
+  ///In a sense, the path can be treated as a graph, for is has \c NodeIt
+  ///and \c EdgeIt with the same usage. These types converts to the \c Node
+  ///and \c Edge of the original graph.
+  ///\todo How to clear a path?
+  ///\todo Clarify the consistency checks to do.
   template<typename Graph>
   class DirPath {
@@ -33 +43 @@
   public:
 
+    /// Constructor
+    
+    /// \param _G The graph in which the path is.
+    ///
     DirPath(const Graph &_G) : gr(&_G) {}
 
     /// Subpath defined by two nodes.
-    /// It is an error if the two edges are not in order!
+    /// \warning It is an error if the two edges are not in order!
     DirPath(const DirPath &P, const NodeIt &a, const NodeIt &b);
     /// Subpath defined by two edges. Contains edges in [a,b)
-    /// It is an error if the two edges are not in order!
+    /// \warning It is an error if the two edges are not in order!
     DirPath(const DirPath &P, const EdgeIt &a, const EdgeIt &b);
 
@@ -129 +143 @@
 
     friend class Builder;    
+
+    ///Class to build paths
+
+    ///\ingroup datas
+    ///This class is used to build new paths.
+    ///You can push new edges to the front and to the back of the path in
+    ///arbitrary order the you can commit these changes to the graph.
+    ///\todo We must clarify when the path will be in "transitional" state.
     class Builder {
       DirPath &P;
@@ -134 +156 @@
 
     public:
+      ///Constructor
+
+      ///\param _P the path you want to build.
+      ///
       Builder(DirPath &_P) : P(_P) {}
 
+      ///Set the first node of the path.
+      
+      ///Set the first node of the path.
+      ///If the path is empty, this must be call before any call of
+      ///\ref pushFront() or \ref pushBack()
+      void setFirst(const GraphNode &) { }
+      
+      ///Push a new edge to the front of the path
+
+      ///Push a new edge to the front of the path.
+      ///\sa setFirst()
       bool pushFront(const GraphEdge& e) {
         if( empty() || P.gr->head(e)==from() ) {
@@ -143 +180 @@
         return false;
       }
+      ///Push a new edge to the back of the path
+
+      ///Push a new edge to the back of the path.
+      ///\sa setFirst()
       bool pushBack(const GraphEdge& e) {
         if( empty() || P.gr->tail(e)==to() ) {
@@ -151 +192 @@
       }
 
+      ///Commit the changes to the path.
       void commit() {
         if( !d.empty() ) {
@@ -158 +200 @@
       }
 
+      ///Desctuctor
+
+      ///The desctuctor.
+      ///It commit also commit the changes.
+      ///\todo Is this what we want?
       ~Builder() { commit(); }
 
@@ -190 +237 @@
 
   };
-
 
 
@@ -613 +659 @@
   }
 
+  ///@}
 
 } // namespace hugo