Changeset 964:2c0c20e90116 in lemon-0.x for src/lemon/graph_utils.h

Timestamp:

11/05/04 08:26:20 (19 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Doc improvements

File:

• src/lemon/graph_utils.h (modified) (6 diffs)

src/lemon/graph_utils.h

@@ -25 +25 @@
 ///\file
 ///\brief Graph utilities.
+///
+///\todo Please
+///revise the documentation.
 ///
 
@@ -53 +56 @@
   /// 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 O(1).
+  /// graph structure it is specialized to run in O(1).
 
   template <typename Graph>
@@ -64 +67 @@
   /// 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 O(1).
+  /// graph structure it is specialized to run in O(1).
   template <typename Graph>
   inline int countEdges(const Graph& _g) {
@@ -74 +77 @@
   /// This function counts the symmetric edges in the graph.
   /// The complexity of the function is O(e) but for some
-  /// graph structure it is specialized to O(1).
+  /// graph structure it is specialized to run in O(1).
   template <typename Graph>
   inline int countSymEdges(const Graph& _g) {
@@ -88 +91 @@
     return num;
   }
+  
+  ///\e
 
+  ///\todo Please document.
+  ///
   template <typename Graph>
   inline int countOutEdges(const Graph& _g,  const typename Graph::Node& _n) {
@@ -94 +101 @@
   }
 
+  ///\e
+
+  ///\todo Please document.
+  ///
   template <typename Graph>
   inline int countInEdges(const Graph& _g,  const typename Graph::Node& _n) {