# HG changeset patch # User deba # Date 1131993615 0 # Node ID d8130458dd86e424260278ee004cc3b4b8535327 # Parent febe52db9b67a6014c9239e78e22d1e2f8e3e434 Documentation fixes diff -r febe52db9b67 -r d8130458dd86 lemon/topology.h --- a/lemon/topology.h Mon Nov 14 18:39:17 2005 +0000 +++ b/lemon/topology.h Mon Nov 14 18:40:15 2005 +0000 @@ -70,7 +70,7 @@ /// /// Count the number of connected components of an undirected graph /// - /// \param g The graph. In must be undirected. + /// \param graph The graph. It should be undirected. /// \return The number of components template int countConnectedComponents(const UndirGraph &graph) { @@ -113,8 +113,8 @@ /// \image html connected_components.png /// \image latex connected_components.eps "Connected components" width=\textwidth /// - /// \param g The graph. In must be undirected. - /// \retval comp A writable node map. The values will be set from 0 to + /// \param graph The graph. It should be undirected. + /// \retval compMap A writable node map. The values will be set from 0 to /// the number of the connected components minus one. Each values of the map /// will be set exactly once, the values of a certain component will be /// set continuously. @@ -237,7 +237,7 @@ /// \return %False when the graph is not strongly connected. /// \see connected /// - /// \waning Empty graph is not strongly connected. + /// \warning Empty graph is not strongly connected. template bool stronglyConnected(const Graph& graph) { checkConcept(); @@ -291,7 +291,7 @@ /// relation on the nodes of the graph. Two nodes are connected with /// directed paths in both direction. /// - /// \param g The graph. + /// \param graph The graph. /// \return The number of components template int countStronglyConnectedComponents(const Graph& graph) { @@ -355,8 +355,12 @@ /// \image html strongly_connected_components.png /// \image latex strongly_connected_components.eps "Strongly connected components" width=\textwidth /// - /// \param g The graph. - /// \retval comp A writable node map. The values will be set from 0 to + /// \param graph The graph. + /// \param compMap A writable node map. The values will be set from 0 to + /// the number of the connected components minus one. Each values of the map + /// will be set exactly once, the values of a certain component will be + /// set continuously. + /// \retval compMap A writable node map. The values will be set from 0 to /// the number of the strongly connected components minus one. Each values /// of the map will be set exactly once, the values of a certain component /// will be set continuously. @@ -420,9 +424,9 @@ /// when there are directed paths between them in both direction. /// The strongly connected components are separated by the cut edges. /// - /// \param g The graph. - /// \retval comp A writable edge map. The values will be set true when - /// the edge is cut edge otherwise false. + /// \param graph The graph. + /// \retval cutMap A writable node map. The values will be set true when the + /// edge is a cut edge. /// /// \return The number of cut edges template @@ -758,8 +762,8 @@ /// \image latex node_biconnected_components.eps "bi-node-connected components" width=\textwidth /// /// \param graph The graph. - /// \retval comp A writable undir edge map. The values will be set from 0 to - /// the number of the biconnected components minus one. Each values + /// \retval compMap A writable undir edge map. The values will be set from 0 + /// to the number of the biconnected components minus one. Each values /// of the map will be set exactly once, the values of a certain component /// will be set continuously. /// \return The number of components. @@ -802,7 +806,7 @@ /// are separted by nodes which are the cut nodes of the components. /// /// \param graph The graph. - /// \retval comp A writable edge map. The values will be set true when + /// \retval cutMap A writable edge map. The values will be set true when /// the node separate two or more components. /// \return The number of the cut nodes. template @@ -1085,7 +1089,7 @@ /// \image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth /// /// \param graph The graph. - /// \retval comp A writable node map. The values will be set from 0 to + /// \retval compMap A writable node map. The values will be set from 0 to /// the number of the biconnected components minus one. Each values /// of the map will be set exactly once, the values of a certain component /// will be set continuously. @@ -1129,7 +1133,7 @@ /// components. /// /// \param graph The graph. - /// \retval comp A writable node map. The values will be set true when the + /// \retval cutMap A writable node map. The values will be set true when the /// edge is a cut edge. /// \return The number of cut edges. template @@ -1187,8 +1191,8 @@ /// /// Sort the nodes of a DAG into topolgical order. /// - /// \param g The graph. In must be directed and acyclic. - /// \retval comp A writable node map. The values will be set from 0 to + /// \param graph The graph. It should be directed and acyclic. + /// \retval order A writable node map. The values will be set from 0 to /// the number of the nodes in the graph minus one. Each values of the map /// will be set exactly once, the values will be set descending order. /// @@ -1227,7 +1231,7 @@ /// Sort the nodes of a DAG into topolgical order. It also checks /// that the given graph is DAG. /// - /// \param g The graph. In must be directed and acyclic. + /// \param graph The graph. It should be directed and acyclic. /// \retval order A readable - writable node map. The values will be set /// from 0 to the number of the nodes in the graph minus one. Each values /// of the map will be set exactly once, the values will be set descending