Changeset 964:2c0c20e90116 in lemon-0.x

Timestamp:

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

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Doc improvements

Location:

src/lemon

Files:

• concept/graph_component.h (modified) (1 diff)
• dimacs.h (modified) (4 diffs)
• graph_utils.h (modified) (6 diffs)
• xy.h (modified) (1 diff)

src/lemon/concept/graph_component.h

@@ -35 +35 @@
 
     /// \note Because Node and Edge are forbidden to inherit from the same
-    /// base class, this is a template. For Node you shoul instantiate it
+    /// base class, this is a template. For Node you should instantiate it
     /// with character 'n' and for Edge with 'e'.
 

src/lemon/dimacs.h

@@ -36 +36 @@
 
   /// This function reads a min cost flow instance from dimacs format,
-  /// i.e. from dimacs files having a line starting with \c p \c "min".
+  /// i.e. from dimacs files having a line starting with
+  /// \code
+  /// p "min"
+  /// \endcode
   /// At the beginning \c g is cleared by \c g.clear(). The edge
   /// capacities are written to \c capacity, \c s and \c t are set to
@@ -113 +116 @@
 
   /// This function reads a max flow instance from dimacs format,
-  /// i.e. from dimacs files having a line starting with \c p \c
-  /// "max".  At the beginning \c g is cleared by \c g.clear(). The
+  /// i.e. from dimacs files having a line starting with
+  /// \code
+  /// p "max"
+  /// \endcode
+  ///At the beginning \c g is cleared by \c g.clear(). The
   /// edge capacities are written to \c capacity and \c s and \c t are
   /// set to the source and the target nodes.
@@ -130 +136 @@
 
   /// This function reads a shortest path instance from dimacs format,
-  /// i.e. from dimacs files having a line starting with \c p \c "sp".
+  /// i.e. from dimacs files having a line starting with
+  /// \code
+  /// p "sp"
+  /// \endcode
   /// At the beginning \c g is cleared by \c g.clear(). The edge
   /// capacities are written to \c capacity and \c s is set to the
@@ -163 +172 @@
   /// This function reads a graph without any designated nodes and
   /// maps from dimacs format, i.e. from dimacs files having a line
-  /// starting with \c p \c "mat".  At the beginning \c g is cleared
+  /// starting with
+  /// \code
+  /// p "mat"
+  /// \endcode
+  /// At the beginning \c g is cleared
   /// by \c g.clear().
   ///

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) {

src/lemon/xy.h

@@ -51 +51 @@
     public:
 
+      typedef T ValueType;
+
       T x,y;