Changeset 2474:e6368948d5f7 in lemon-0.x

Timestamp:

09/20/07 01:35:27 (17 years ago)

Author:

Peter Kovacs

Branch:

default

Phase:

public

Convert:

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

Message:

Small bug fixes and changes in the documentation.

Location:

lemon

Files:

• concepts/bpugraph.h (modified) (2 diffs)
• concepts/graph.h (modified) (2 diffs)
• concepts/graph_components.h (modified) (1 diff)
• concepts/ugraph.h (modified) (2 diffs)
• graph_utils.h (modified) (14 diffs)
• min_cost_flow.h (modified) (1 diff)

lemon/concepts/bpugraph.h

@@ -19 +19 @@
 /// \ingroup graph_concepts
 /// \file
-/// \brief Undirected bipartite graphs and components of.
-
+/// \brief The concept of Bipartite Undirected Graphs.
 
 #ifndef LEMON_CONCEPT_BPUGRAPH_H
@@ -37 +36 @@
     /// \addtogroup graph_concepts
     /// @{
-
-
+    ///
     /// \brief Class describing the concept of Bipartite Undirected Graphs.
     ///

lemon/concepts/graph.h

@@ -22 +22 @@
 ///\ingroup graph_concepts
 ///\file
-///\brief Declaration of Graph.
+///\brief The concept of Directed Graphs.
 
 #include <lemon/bits/invalid.h>
@@ -35 +35 @@
     /// \addtogroup graph_concepts
     /// @{
-
-    /// The directed graph concept
-
+    ///
+    /// \brief Class describing the concept of Directed Graphs.
+    ///
     /// This class describes the \ref concept "concept" of the
     /// immutable directed graphs.

lemon/concepts/graph_components.h

@@ -19 +19 @@
 ///\ingroup graph_concepts
 ///\file
-///\brief The concept of the graph components.
+///\brief The concept of graph components.
 
 

lemon/concepts/ugraph.h

@@ -19 +19 @@
 ///\ingroup graph_concepts
 ///\file
-///\brief The concept of the undirected graphs.
-
+///\brief The concept of Undirected Graphs.
 
 #ifndef LEMON_CONCEPT_UGRAPH_H
@@ -34 +33 @@
     /// \addtogroup graph_concepts
     /// @{
-
-
+    ///
     /// \brief Class describing the concept of Undirected Graphs.
     ///

lemon/graph_utils.h

@@ -37 +37 @@
 ///\file
 ///\brief Graph utilities.
-///
-///
-
 
 namespace lemon {
@@ -150 +147 @@
   /// graph structures it is specialized to run in O(1).
   ///
-  /// \todo refer how to specialize it
+  /// \todo Refer how to specialize it.
 
   template <typename Graph>
@@ -183 +180 @@
   /// graph structures it is specialized to run in O(1).
   ///
-  /// \todo refer how to specialize it
+  /// \todo Refer how to specialize it.
 
   template <typename Graph>
@@ -216 +213 @@
   /// graph structures it is specialized to run in O(1).
   ///
-  /// \todo refer how to specialize it
+  /// \todo Refer how to specialize it.
 
   template <typename Graph>
@@ -376 +373 @@
   ///
   ///\sa EdgeLookUp
-  ///\se AllEdgeLookup
+  ///\se AllEdgeLookUp
   ///\sa ConEdgeIt
   template <typename Graph>
@@ -398 +395 @@
   ///\sa findEdge()
   ///\sa EdgeLookUp
-  ///\sa AllEdgeLookup
+  ///\sa AllEdgeLookUp
   ///
   /// \author Balazs Dezso 
@@ -2042 +2039 @@
   ///
   /// The SourceMap gives back the source Node of the given edge. 
+  /// \see TargetMap
   /// \author Balazs Dezso
   template <typename Graph>
@@ -2069 +2067 @@
   };
 
-  /// \brief Returns a \ref SourceMap class
+  /// \brief Returns a \ref SourceMap class.
   ///
   /// This function just returns an \ref SourceMap class.
@@ -2081 +2079 @@
   ///
   /// The TargetMap gives back the target Node of the given edge. 
+  /// \see SourceMap
   /// \author Balazs Dezso
   template <typename Graph>
@@ -2108 +2107 @@
   };
 
-  /// \brief Returns a \ref TargetMap class
+  /// \brief Returns a \ref TargetMap class.
   ///
   /// This function just returns a \ref TargetMap class.
@@ -2120 +2119 @@
   ///
   /// Returns the "forward" directed edge view of an undirected edge.
+  /// \see BackwardMap
   /// \author Balazs Dezso
   template <typename Graph>
@@ -2147 +2147 @@
   };
 
-  /// \brief Returns a \ref ForwardMap class
+  /// \brief Returns a \ref ForwardMap class.
   ///
   /// This function just returns an \ref ForwardMap class.
@@ -2159 +2159 @@
   ///
   /// Returns the "backward" directed edge view of an undirected edge.
+  /// \see ForwardMap
   /// \author Balazs Dezso
   template <typename Graph>
@@ -2225 +2226 @@
   };
 
-  /// \brief Just returns a PotentialDifferenceMap
-  ///
-  /// Just returns a PotentialDifferenceMap
+  /// \brief Returns a PotentialDifferenceMap.
+  ///
+  /// This function just returns a PotentialDifferenceMap.
   /// \relates PotentialDifferenceMap
   template <typename Graph, typename NodeMap>

lemon/min_cost_flow.h

@@ -40 +40 @@
   /// \ref lemon::NetworkSimplex "NetworkSimplex", wich is the most
   /// efficient implementation for the minimum cost flow problem in the
-  /// Lemon library according to our benchmark tests.
+  /// LEMON library according to our benchmark tests.
   ///
   /// \note There are three implementations for the minimum cost flow