Small bug fixes and changes in the documentation.
1.1 --- a/lemon/concepts/bpugraph.h Sun Sep 16 14:21:12 2007 +0000
1.2 +++ b/lemon/concepts/bpugraph.h Wed Sep 19 23:35:27 2007 +0000
1.3 @@ -18,8 +18,7 @@
1.4
1.5 /// \ingroup graph_concepts
1.6 /// \file
1.7 -/// \brief Undirected bipartite graphs and components of.
1.8 -
1.9 +/// \brief The concept of Bipartite Undirected Graphs.
1.10
1.11 #ifndef LEMON_CONCEPT_BPUGRAPH_H
1.12 #define LEMON_CONCEPT_BPUGRAPH_H
1.13 @@ -36,8 +35,7 @@
1.14
1.15 /// \addtogroup graph_concepts
1.16 /// @{
1.17 -
1.18 -
1.19 + ///
1.20 /// \brief Class describing the concept of Bipartite Undirected Graphs.
1.21 ///
1.22 /// This class describes the common interface of all
2.1 --- a/lemon/concepts/graph.h Sun Sep 16 14:21:12 2007 +0000
2.2 +++ b/lemon/concepts/graph.h Wed Sep 19 23:35:27 2007 +0000
2.3 @@ -21,7 +21,7 @@
2.4
2.5 ///\ingroup graph_concepts
2.6 ///\file
2.7 -///\brief Declaration of Graph.
2.8 +///\brief The concept of Directed Graphs.
2.9
2.10 #include <lemon/bits/invalid.h>
2.11 #include <lemon/bits/utility.h>
2.12 @@ -34,9 +34,9 @@
2.13
2.14 /// \addtogroup graph_concepts
2.15 /// @{
2.16 -
2.17 - /// The directed graph concept
2.18 -
2.19 + ///
2.20 + /// \brief Class describing the concept of Directed Graphs.
2.21 + ///
2.22 /// This class describes the \ref concept "concept" of the
2.23 /// immutable directed graphs.
2.24 ///
3.1 --- a/lemon/concepts/graph_components.h Sun Sep 16 14:21:12 2007 +0000
3.2 +++ b/lemon/concepts/graph_components.h Wed Sep 19 23:35:27 2007 +0000
3.3 @@ -18,7 +18,7 @@
3.4
3.5 ///\ingroup graph_concepts
3.6 ///\file
3.7 -///\brief The concept of the graph components.
3.8 +///\brief The concept of graph components.
3.9
3.10
3.11 #ifndef LEMON_CONCEPT_GRAPH_COMPONENTS_H
4.1 --- a/lemon/concepts/ugraph.h Sun Sep 16 14:21:12 2007 +0000
4.2 +++ b/lemon/concepts/ugraph.h Wed Sep 19 23:35:27 2007 +0000
4.3 @@ -18,8 +18,7 @@
4.4
4.5 ///\ingroup graph_concepts
4.6 ///\file
4.7 -///\brief The concept of the undirected graphs.
4.8 -
4.9 +///\brief The concept of Undirected Graphs.
4.10
4.11 #ifndef LEMON_CONCEPT_UGRAPH_H
4.12 #define LEMON_CONCEPT_UGRAPH_H
4.13 @@ -33,8 +32,7 @@
4.14
4.15 /// \addtogroup graph_concepts
4.16 /// @{
4.17 -
4.18 -
4.19 + ///
4.20 /// \brief Class describing the concept of Undirected Graphs.
4.21 ///
4.22 /// This class describes the common interface of all Undirected
5.1 --- a/lemon/graph_utils.h Sun Sep 16 14:21:12 2007 +0000
5.2 +++ b/lemon/graph_utils.h Wed Sep 19 23:35:27 2007 +0000
5.3 @@ -36,9 +36,6 @@
5.4 ///\ingroup gutils
5.5 ///\file
5.6 ///\brief Graph utilities.
5.7 -///
5.8 -///
5.9 -
5.10
5.11 namespace lemon {
5.12
5.13 @@ -149,7 +146,7 @@
5.14 /// The complexity of the function is O(n) but for some
5.15 /// graph structures it is specialized to run in O(1).
5.16 ///
5.17 - /// \todo refer how to specialize it
5.18 + /// \todo Refer how to specialize it.
5.19
5.20 template <typename Graph>
5.21 inline int countNodes(const Graph& g) {
5.22 @@ -182,7 +179,7 @@
5.23 /// The complexity of the function is O(an) but for some
5.24 /// graph structures it is specialized to run in O(1).
5.25 ///
5.26 - /// \todo refer how to specialize it
5.27 + /// \todo Refer how to specialize it.
5.28
5.29 template <typename Graph>
5.30 inline int countANodes(const Graph& g) {
5.31 @@ -215,7 +212,7 @@
5.32 /// The complexity of the function is O(bn) but for some
5.33 /// graph structures it is specialized to run in O(1).
5.34 ///
5.35 - /// \todo refer how to specialize it
5.36 + /// \todo Refer how to specialize it.
5.37
5.38 template <typename Graph>
5.39 inline int countBNodes(const Graph& g) {
5.40 @@ -375,7 +372,7 @@
5.41 ///\endcode
5.42 ///
5.43 ///\sa EdgeLookUp
5.44 - ///\se AllEdgeLookup
5.45 + ///\se AllEdgeLookUp
5.46 ///\sa ConEdgeIt
5.47 template <typename Graph>
5.48 inline typename Graph::Edge
5.49 @@ -397,7 +394,7 @@
5.50 ///
5.51 ///\sa findEdge()
5.52 ///\sa EdgeLookUp
5.53 - ///\sa AllEdgeLookup
5.54 + ///\sa AllEdgeLookUp
5.55 ///
5.56 /// \author Balazs Dezso
5.57 template <typename _Graph>
5.58 @@ -2041,6 +2038,7 @@
5.59 /// \brief Returns the source of the given edge.
5.60 ///
5.61 /// The SourceMap gives back the source Node of the given edge.
5.62 + /// \see TargetMap
5.63 /// \author Balazs Dezso
5.64 template <typename Graph>
5.65 class SourceMap {
5.66 @@ -2068,7 +2066,7 @@
5.67 const Graph& graph;
5.68 };
5.69
5.70 - /// \brief Returns a \ref SourceMap class
5.71 + /// \brief Returns a \ref SourceMap class.
5.72 ///
5.73 /// This function just returns an \ref SourceMap class.
5.74 /// \relates SourceMap
5.75 @@ -2080,6 +2078,7 @@
5.76 /// \brief Returns the target of the given edge.
5.77 ///
5.78 /// The TargetMap gives back the target Node of the given edge.
5.79 + /// \see SourceMap
5.80 /// \author Balazs Dezso
5.81 template <typename Graph>
5.82 class TargetMap {
5.83 @@ -2107,7 +2106,7 @@
5.84 const Graph& graph;
5.85 };
5.86
5.87 - /// \brief Returns a \ref TargetMap class
5.88 + /// \brief Returns a \ref TargetMap class.
5.89 ///
5.90 /// This function just returns a \ref TargetMap class.
5.91 /// \relates TargetMap
5.92 @@ -2119,6 +2118,7 @@
5.93 /// \brief Returns the "forward" directed edge view of an undirected edge.
5.94 ///
5.95 /// Returns the "forward" directed edge view of an undirected edge.
5.96 + /// \see BackwardMap
5.97 /// \author Balazs Dezso
5.98 template <typename Graph>
5.99 class ForwardMap {
5.100 @@ -2146,7 +2146,7 @@
5.101 const Graph& graph;
5.102 };
5.103
5.104 - /// \brief Returns a \ref ForwardMap class
5.105 + /// \brief Returns a \ref ForwardMap class.
5.106 ///
5.107 /// This function just returns an \ref ForwardMap class.
5.108 /// \relates ForwardMap
5.109 @@ -2158,6 +2158,7 @@
5.110 /// \brief Returns the "backward" directed edge view of an undirected edge.
5.111 ///
5.112 /// Returns the "backward" directed edge view of an undirected edge.
5.113 + /// \see ForwardMap
5.114 /// \author Balazs Dezso
5.115 template <typename Graph>
5.116 class BackwardMap {
5.117 @@ -2224,9 +2225,9 @@
5.118 const NodeMap& potential;
5.119 };
5.120
5.121 - /// \brief Just returns a PotentialDifferenceMap
5.122 + /// \brief Returns a PotentialDifferenceMap.
5.123 ///
5.124 - /// Just returns a PotentialDifferenceMap
5.125 + /// This function just returns a PotentialDifferenceMap.
5.126 /// \relates PotentialDifferenceMap
5.127 template <typename Graph, typename NodeMap>
5.128 PotentialDifferenceMap<Graph, NodeMap>
6.1 --- a/lemon/min_cost_flow.h Sun Sep 16 14:21:12 2007 +0000
6.2 +++ b/lemon/min_cost_flow.h Wed Sep 19 23:35:27 2007 +0000
6.3 @@ -39,7 +39,7 @@
6.4 /// \note \ref lemon::MinCostFlow "MinCostFlow" is just an alias for
6.5 /// \ref lemon::NetworkSimplex "NetworkSimplex", wich is the most
6.6 /// efficient implementation for the minimum cost flow problem in the
6.7 - /// Lemon library according to our benchmark tests.
6.8 + /// LEMON library according to our benchmark tests.
6.9 ///
6.10 /// \note There are three implementations for the minimum cost flow
6.11 /// problem, that can be used in the same way.