# HG changeset patch # User kpeter # Date 1190244927 0 # Node ID e6368948d5f76ebaf5eb1713520a282b08f3a6f1 # Parent 9ffff9051a4b847385e1bce39d55c4ff1fa4b44e Small bug fixes and changes in the documentation. diff -r 9ffff9051a4b -r e6368948d5f7 lemon/concepts/bpugraph.h --- a/lemon/concepts/bpugraph.h Sun Sep 16 14:21:12 2007 +0000 +++ b/lemon/concepts/bpugraph.h Wed Sep 19 23:35:27 2007 +0000 @@ -18,8 +18,7 @@ /// \ingroup graph_concepts /// \file -/// \brief Undirected bipartite graphs and components of. - +/// \brief The concept of Bipartite Undirected Graphs. #ifndef LEMON_CONCEPT_BPUGRAPH_H #define LEMON_CONCEPT_BPUGRAPH_H @@ -36,8 +35,7 @@ /// \addtogroup graph_concepts /// @{ - - + /// /// \brief Class describing the concept of Bipartite Undirected Graphs. /// /// This class describes the common interface of all diff -r 9ffff9051a4b -r e6368948d5f7 lemon/concepts/graph.h --- a/lemon/concepts/graph.h Sun Sep 16 14:21:12 2007 +0000 +++ b/lemon/concepts/graph.h Wed Sep 19 23:35:27 2007 +0000 @@ -21,7 +21,7 @@ ///\ingroup graph_concepts ///\file -///\brief Declaration of Graph. +///\brief The concept of Directed Graphs. #include #include @@ -34,9 +34,9 @@ /// \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. /// diff -r 9ffff9051a4b -r e6368948d5f7 lemon/concepts/graph_components.h --- a/lemon/concepts/graph_components.h Sun Sep 16 14:21:12 2007 +0000 +++ b/lemon/concepts/graph_components.h Wed Sep 19 23:35:27 2007 +0000 @@ -18,7 +18,7 @@ ///\ingroup graph_concepts ///\file -///\brief The concept of the graph components. +///\brief The concept of graph components. #ifndef LEMON_CONCEPT_GRAPH_COMPONENTS_H diff -r 9ffff9051a4b -r e6368948d5f7 lemon/concepts/ugraph.h --- a/lemon/concepts/ugraph.h Sun Sep 16 14:21:12 2007 +0000 +++ b/lemon/concepts/ugraph.h Wed Sep 19 23:35:27 2007 +0000 @@ -18,8 +18,7 @@ ///\ingroup graph_concepts ///\file -///\brief The concept of the undirected graphs. - +///\brief The concept of Undirected Graphs. #ifndef LEMON_CONCEPT_UGRAPH_H #define LEMON_CONCEPT_UGRAPH_H @@ -33,8 +32,7 @@ /// \addtogroup graph_concepts /// @{ - - + /// /// \brief Class describing the concept of Undirected Graphs. /// /// This class describes the common interface of all Undirected diff -r 9ffff9051a4b -r e6368948d5f7 lemon/graph_utils.h --- a/lemon/graph_utils.h Sun Sep 16 14:21:12 2007 +0000 +++ b/lemon/graph_utils.h Wed Sep 19 23:35:27 2007 +0000 @@ -36,9 +36,6 @@ ///\ingroup gutils ///\file ///\brief Graph utilities. -/// -/// - namespace lemon { @@ -149,7 +146,7 @@ /// The complexity of the function is O(n) but for some /// graph structures it is specialized to run in O(1). /// - /// \todo refer how to specialize it + /// \todo Refer how to specialize it. template inline int countNodes(const Graph& g) { @@ -182,7 +179,7 @@ /// The complexity of the function is O(an) but for some /// graph structures it is specialized to run in O(1). /// - /// \todo refer how to specialize it + /// \todo Refer how to specialize it. template inline int countANodes(const Graph& g) { @@ -215,7 +212,7 @@ /// The complexity of the function is O(bn) but for some /// graph structures it is specialized to run in O(1). /// - /// \todo refer how to specialize it + /// \todo Refer how to specialize it. template inline int countBNodes(const Graph& g) { @@ -375,7 +372,7 @@ ///\endcode /// ///\sa EdgeLookUp - ///\se AllEdgeLookup + ///\se AllEdgeLookUp ///\sa ConEdgeIt template inline typename Graph::Edge @@ -397,7 +394,7 @@ /// ///\sa findEdge() ///\sa EdgeLookUp - ///\sa AllEdgeLookup + ///\sa AllEdgeLookUp /// /// \author Balazs Dezso template @@ -2041,6 +2038,7 @@ /// \brief Returns the source of the given edge. /// /// The SourceMap gives back the source Node of the given edge. + /// \see TargetMap /// \author Balazs Dezso template class SourceMap { @@ -2068,7 +2066,7 @@ const Graph& graph; }; - /// \brief Returns a \ref SourceMap class + /// \brief Returns a \ref SourceMap class. /// /// This function just returns an \ref SourceMap class. /// \relates SourceMap @@ -2080,6 +2078,7 @@ /// \brief Returns the target of the given edge. /// /// The TargetMap gives back the target Node of the given edge. + /// \see SourceMap /// \author Balazs Dezso template class TargetMap { @@ -2107,7 +2106,7 @@ const Graph& graph; }; - /// \brief Returns a \ref TargetMap class + /// \brief Returns a \ref TargetMap class. /// /// This function just returns a \ref TargetMap class. /// \relates TargetMap @@ -2119,6 +2118,7 @@ /// \brief Returns the "forward" directed edge view of an undirected edge. /// /// Returns the "forward" directed edge view of an undirected edge. + /// \see BackwardMap /// \author Balazs Dezso template class ForwardMap { @@ -2146,7 +2146,7 @@ const Graph& graph; }; - /// \brief Returns a \ref ForwardMap class + /// \brief Returns a \ref ForwardMap class. /// /// This function just returns an \ref ForwardMap class. /// \relates ForwardMap @@ -2158,6 +2158,7 @@ /// \brief Returns the "backward" directed edge view of an undirected edge. /// /// Returns the "backward" directed edge view of an undirected edge. + /// \see ForwardMap /// \author Balazs Dezso template class BackwardMap { @@ -2224,9 +2225,9 @@ const NodeMap& potential; }; - /// \brief Just returns a PotentialDifferenceMap + /// \brief Returns a PotentialDifferenceMap. /// - /// Just returns a PotentialDifferenceMap + /// This function just returns a PotentialDifferenceMap. /// \relates PotentialDifferenceMap template PotentialDifferenceMap diff -r 9ffff9051a4b -r e6368948d5f7 lemon/min_cost_flow.h --- a/lemon/min_cost_flow.h Sun Sep 16 14:21:12 2007 +0000 +++ b/lemon/min_cost_flow.h Wed Sep 19 23:35:27 2007 +0000 @@ -39,7 +39,7 @@ /// \note \ref lemon::MinCostFlow "MinCostFlow" is just an alias for /// \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 /// problem, that can be used in the same way.