1.1 --- a/lemon/topology.h	Mon Nov 14 18:39:17 2005 +0000
     1.2 +++ b/lemon/topology.h	Mon Nov 14 18:40:15 2005 +0000
     1.3 @@ -70,7 +70,7 @@
     1.4    ///
     1.5    /// Count the number of connected components of an undirected graph
     1.6    ///
     1.7 -  /// \param g The graph. In must be undirected.
     1.8 +  /// \param graph The graph. It should be undirected.
     1.9    /// \return The number of components
    1.10    template <typename UndirGraph>
    1.11    int countConnectedComponents(const UndirGraph &graph) {
    1.12 @@ -113,8 +113,8 @@
    1.13    /// \image html connected_components.png
    1.14    /// \image latex connected_components.eps "Connected components" width=\textwidth
    1.15    ///
    1.16 -  /// \param g The graph. In must be undirected.
    1.17 -  /// \retval comp A writable node map. The values will be set from 0 to
    1.18 +  /// \param graph The graph. It should be undirected.
    1.19 +  /// \retval compMap A writable node map. The values will be set from 0 to
    1.20    /// the number of the connected components minus one. Each values of the map
    1.21    /// will be set exactly once, the values of a certain component will be
    1.22    /// set continuously.
    1.23 @@ -237,7 +237,7 @@
    1.24    /// \return %False when the graph is not strongly connected.
    1.25    /// \see connected
    1.26    ///
    1.27 -  /// \waning Empty graph is not strongly connected.
    1.28 +  /// \warning Empty graph is not strongly connected.
    1.29    template <typename Graph>
    1.30    bool stronglyConnected(const Graph& graph) {
    1.31      checkConcept<concept::StaticGraph, Graph>();
    1.32 @@ -291,7 +291,7 @@
    1.33    /// relation on the nodes of the graph. Two nodes are connected with
    1.34    /// directed paths in both direction.
    1.35    ///
    1.36 -  /// \param g The graph.
    1.37 +  /// \param graph The graph.
    1.38    /// \return The number of components
    1.39    template <typename Graph>
    1.40    int countStronglyConnectedComponents(const Graph& graph) {
    1.41 @@ -355,8 +355,12 @@
    1.42    /// \image html strongly_connected_components.png
    1.43    /// \image latex strongly_connected_components.eps "Strongly connected components" width=\textwidth
    1.44    ///
    1.45 -  /// \param g The graph.
    1.46 -  /// \retval comp A writable node map. The values will be set from 0 to
    1.47 +  /// \param graph The graph.
    1.48 +  /// \param compMap A writable node map. The values will be set from 0 to
    1.49 +  /// the number of the connected components minus one. Each values of the map
    1.50 +  /// will be set exactly once, the values of a certain component will be
    1.51 +  /// set continuously.
    1.52 +  /// \retval compMap A writable node map. The values will be set from 0 to
    1.53    /// the number of the strongly connected components minus one. Each values 
    1.54    /// of the map will be set exactly once, the values of a certain component 
    1.55    /// will be set continuously.
    1.56 @@ -420,9 +424,9 @@
    1.57    /// when there are directed paths between them in both direction.
    1.58    /// The strongly connected components are separated by the cut edges.
    1.59    ///
    1.60 -  /// \param g The graph.
    1.61 -  /// \retval comp A writable edge map. The values will be set true when
    1.62 -  /// the edge is cut edge otherwise false.
    1.63 +  /// \param graph The graph.
    1.64 +  /// \retval cutMap A writable node map. The values will be set true when the
    1.65 +  /// edge is a cut edge.
    1.66    ///
    1.67    /// \return The number of cut edges
    1.68    template <typename Graph, typename EdgeMap>
    1.69 @@ -758,8 +762,8 @@
    1.70    /// \image latex node_biconnected_components.eps "bi-node-connected components" width=\textwidth
    1.71    ///
    1.72    /// \param graph The graph.
    1.73 -  /// \retval comp A writable undir edge map. The values will be set from 0 to
    1.74 -  /// the number of the biconnected components minus one. Each values 
    1.75 +  /// \retval compMap A writable undir edge map. The values will be set from 0
    1.76 +  /// to the number of the biconnected components minus one. Each values 
    1.77    /// of the map will be set exactly once, the values of a certain component 
    1.78    /// will be set continuously.
    1.79    /// \return The number of components.
    1.80 @@ -802,7 +806,7 @@
    1.81    /// are separted by nodes which are the cut nodes of the components.
    1.82    ///
    1.83    /// \param graph The graph.
    1.84 -  /// \retval comp A writable edge map. The values will be set true when
    1.85 +  /// \retval cutMap A writable edge map. The values will be set true when
    1.86    /// the node separate two or more components.
    1.87    /// \return The number of the cut nodes.
    1.88    template <typename UndirGraph, typename NodeMap>
    1.89 @@ -1085,7 +1089,7 @@
    1.90    /// \image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth
    1.91    ///
    1.92    /// \param graph The graph.
    1.93 -  /// \retval comp A writable node map. The values will be set from 0 to
    1.94 +  /// \retval compMap A writable node map. The values will be set from 0 to
    1.95    /// the number of the biconnected components minus one. Each values 
    1.96    /// of the map will be set exactly once, the values of a certain component 
    1.97    /// will be set continuously.
    1.98 @@ -1129,7 +1133,7 @@
    1.99    /// components.
   1.100    ///
   1.101    /// \param graph The graph.
   1.102 -  /// \retval comp A writable node map. The values will be set true when the
   1.103 +  /// \retval cutMap A writable node map. The values will be set true when the
   1.104    /// edge is a cut edge.
   1.105    /// \return The number of cut edges.
   1.106    template <typename UndirGraph, typename UndirEdgeMap>
   1.107 @@ -1187,8 +1191,8 @@
   1.108    ///
   1.109    /// Sort the nodes of a DAG into topolgical order.
   1.110    ///
   1.111 -  /// \param g The graph. In must be directed and acyclic.
   1.112 -  /// \retval comp A writable node map. The values will be set from 0 to
   1.113 +  /// \param graph The graph. It should be directed and acyclic.
   1.114 +  /// \retval order A writable node map. The values will be set from 0 to
   1.115    /// the number of the nodes in the graph minus one. Each values of the map
   1.116    /// will be set exactly once, the values  will be set descending order.
   1.117    ///
   1.118 @@ -1227,7 +1231,7 @@
   1.119    /// Sort the nodes of a DAG into topolgical order. It also checks
   1.120    /// that the given graph is DAG.
   1.121    ///
   1.122 -  /// \param g The graph. In must be directed and acyclic.
   1.123 +  /// \param graph The graph. It should be directed and acyclic.
   1.124    /// \retval order A readable - writable node map. The values will be set 
   1.125    /// from 0 to the number of the nodes in the graph minus one. Each values 
   1.126    /// of the map will be set exactly once, the values will be set descending