Changeset 1793:d8130458dd86 in lemon-0.x

Timestamp:

11/14/05 19:40:15 (18 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

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

Message:

Documentation fixes

File:

• lemon/topology.h (modified) (12 diffs)

lemon/topology.h

@@ -71 +71 @@
   /// 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 <typename UndirGraph>
@@ -114 +114 @@
   /// \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
@@ -238 +238 @@
   /// \see connected
   ///
-  /// \waning Empty graph is not strongly connected.
+  /// \warning Empty graph is not strongly connected.
   template <typename Graph>
   bool stronglyConnected(const Graph& graph) {
@@ -292 +292 @@
   /// directed paths in both direction.
   ///
-  /// \param g The graph.
+  /// \param graph The graph.
   /// \return The number of components
   template <typename Graph>
@@ -356 +356 @@
   /// \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 
@@ -421 +425 @@
   /// 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
@@ -759 +763 @@
   ///
   /// \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.
@@ -803 +807 @@
   ///
   /// \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.
@@ -1086 +1090 @@
   ///
   /// \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 
@@ -1130 +1134 @@
   ///
   /// \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.
@@ -1188 +1192 @@
   /// 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.
@@ -1228 +1232 @@
   /// 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