Changeset 1526:8c14aa8f27a2 in lemon-0.x for lemon/graph_utils.h

Timestamp:

06/30/05 18:13:30 (19 years ago)

Author:

athos

Branch:

default

Phase:

public

Convert:

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

Message:

Mainly doc review.

File:

• lemon/graph_utils.h (modified) (7 diffs)

lemon/graph_utils.h

@@ -74 +74 @@
   /// This function counts the nodes in the graph.
   /// The complexity of the function is O(n) but for some
-  /// graph structure it is specialized to run in O(1).
+  /// graph structures it is specialized to run in O(1).
   ///
   /// \todo refer how to specialize it
@@ -101 +101 @@
   /// This function counts the edges in the graph.
   /// The complexity of the function is O(e) but for some
-  /// graph structure it is specialized to run in O(1).
+  /// graph structures it is specialized to run in O(1).
 
   template <typename Graph>
@@ -122 +122 @@
   }
 
-  /// \brief Function to count the edges in the graph.
-  ///
-  /// This function counts the edges in the graph.
+  /// \brief Function to count the undirected edges in the graph.
+  ///
+  /// This function counts the undirected edges in the graph.
   /// The complexity of the function is O(e) but for some
   /// graph structure it is specialized to run in O(1).
@@ -175 +175 @@
   }
   
-  ///\e
-
-  ///\todo Please document.
-  ///
+  /// \brief Function to count the number of the out-edges from node \c n.
+  ///
+  /// This function counts the number of the out-edges from node \c n
+  /// in the graph.  
   template <typename Graph>
   inline int countOutEdges(const Graph& _g,  const typename Graph::Node& _n) {
@@ -184 +184 @@
   }
 
-  ///\e
-
-  ///\todo Please document.
-  ///
+  /// \brief Function to count the number of the in-edges to node \c n.
+  ///
+  /// This function counts the number of the in-edges to node \c n
+  /// in the graph.  
   template <typename Graph>
   inline int countInEdges(const Graph& _g,  const typename Graph::Node& _n) {
@@ -365 +365 @@
   /// Provides an immutable and unique id for each item in the graph.
 
-  /// The IdMap class provides an unique and immutable mapping for each item
+  /// The IdMap class provides a unique and immutable mapping for each item
   /// in the graph.
   ///
@@ -430 +430 @@
 
   
-  /// \brief General inversable graph-map type.
-
-  /// This type provides simple inversable map functions. 
-  /// The InversableMap wraps an arbitrary ReadWriteMap 
-  /// and if a key is setted to a new value then store it
+  /// \brief General invertable graph-map type.
+
+  /// This type provides simple invertable map functions. 
+  /// The InvertableMap wraps an arbitrary ReadWriteMap 
+  /// and if a key is set to a new value then store it
   /// in the inverse map.
   /// \param _Graph The graph type.
-  /// \param _Map The map to extend with inversable functionality. 
+  /// \param _Map The map to extend with invertable functionality. 
   template <
     typename _Graph,