1.1 --- a/lemon/graph_utils.h Wed Jun 29 19:44:30 2005 +0000
1.2 +++ b/lemon/graph_utils.h Thu Jun 30 16:13:30 2005 +0000
1.3 @@ -73,7 +73,7 @@
1.4 ///
1.5 /// This function counts the nodes in the graph.
1.6 /// The complexity of the function is O(n) but for some
1.7 - /// graph structure it is specialized to run in O(1).
1.8 + /// graph structures it is specialized to run in O(1).
1.9 ///
1.10 /// \todo refer how to specialize it
1.11
1.12 @@ -100,7 +100,7 @@
1.13 ///
1.14 /// This function counts the edges in the graph.
1.15 /// The complexity of the function is O(e) but for some
1.16 - /// graph structure it is specialized to run in O(1).
1.17 + /// graph structures it is specialized to run in O(1).
1.18
1.19 template <typename Graph>
1.20 inline int countEdges(const Graph& g) {
1.21 @@ -121,9 +121,9 @@
1.22 return countItems<Graph, typename Graph::UndirEdgeIt>(w.value);
1.23 }
1.24
1.25 - /// \brief Function to count the edges in the graph.
1.26 + /// \brief Function to count the undirected edges in the graph.
1.27 ///
1.28 - /// This function counts the edges in the graph.
1.29 + /// This function counts the undirected edges in the graph.
1.30 /// The complexity of the function is O(e) but for some
1.31 /// graph structure it is specialized to run in O(1).
1.32
1.33 @@ -174,19 +174,19 @@
1.34 return e;
1.35 }
1.36
1.37 - ///\e
1.38 -
1.39 - ///\todo Please document.
1.40 + /// \brief Function to count the number of the out-edges from node \c n.
1.41 ///
1.42 + /// This function counts the number of the out-edges from node \c n
1.43 + /// in the graph.
1.44 template <typename Graph>
1.45 inline int countOutEdges(const Graph& _g, const typename Graph::Node& _n) {
1.46 return countNodeDegree<Graph, typename Graph::OutEdgeIt>(_g, _n);
1.47 }
1.48
1.49 - ///\e
1.50 -
1.51 - ///\todo Please document.
1.52 + /// \brief Function to count the number of the in-edges to node \c n.
1.53 ///
1.54 + /// This function counts the number of the in-edges to node \c n
1.55 + /// in the graph.
1.56 template <typename Graph>
1.57 inline int countInEdges(const Graph& _g, const typename Graph::Node& _n) {
1.58 return countNodeDegree<Graph, typename Graph::InEdgeIt>(_g, _n);
1.59 @@ -364,7 +364,7 @@
1.60
1.61 /// Provides an immutable and unique id for each item in the graph.
1.62
1.63 - /// The IdMap class provides an unique and immutable mapping for each item
1.64 + /// The IdMap class provides a unique and immutable mapping for each item
1.65 /// in the graph.
1.66 ///
1.67 template <typename _Graph, typename _Item>
1.68 @@ -429,14 +429,14 @@
1.69 };
1.70
1.71
1.72 - /// \brief General inversable graph-map type.
1.73 + /// \brief General invertable graph-map type.
1.74
1.75 - /// This type provides simple inversable map functions.
1.76 - /// The InversableMap wraps an arbitrary ReadWriteMap
1.77 - /// and if a key is setted to a new value then store it
1.78 + /// This type provides simple invertable map functions.
1.79 + /// The InvertableMap wraps an arbitrary ReadWriteMap
1.80 + /// and if a key is set to a new value then store it
1.81 /// in the inverse map.
1.82 /// \param _Graph The graph type.
1.83 - /// \param _Map The map to extend with inversable functionality.
1.84 + /// \param _Map The map to extend with invertable functionality.
1.85 template <
1.86 typename _Graph,
1.87 typename _Item,