[Lemon-commits] alpar: r3142 - in hugo/trunk: demo doc lemon
Lemon SVN
svn at lemon.cs.elte.hu
Tue Jan 23 13:51:40 CET 2007
Author: alpar
Date: Tue Jan 23 13:51:39 2007
New Revision: 3142
Modified:
hugo/trunk/demo/maps_summary.cc
hugo/trunk/doc/basic_concepts.dox
hugo/trunk/doc/dirs.dox
hugo/trunk/doc/groups.dox
hugo/trunk/lemon/bfs.h
hugo/trunk/lemon/elevator.h
hugo/trunk/lemon/eps.h
hugo/trunk/lemon/euler.h
hugo/trunk/lemon/graph_utils.h
hugo/trunk/lemon/path_utils.h
hugo/trunk/lemon/preflow.h
hugo/trunk/lemon/smart_graph.h
hugo/trunk/lemon/ssp_min_cost_flow.h
Log:
Several doc improvements.
Modified: hugo/trunk/demo/maps_summary.cc
==============================================================================
--- hugo/trunk/demo/maps_summary.cc (original)
+++ hugo/trunk/demo/maps_summary.cc Tue Jan 23 13:51:39 2007
@@ -17,8 +17,8 @@
*/
///\ingroup demos
-///\file maps_summary demo program
-///\brief Introduction to LEMON maps
+///\file
+///\brief An introduction to LEMON maps
///
/// \include maps_summary.cc
Modified: hugo/trunk/doc/basic_concepts.dox
==============================================================================
--- hugo/trunk/doc/basic_concepts.dox (original)
+++ hugo/trunk/doc/basic_concepts.dox Tue Jan 23 13:51:39 2007
@@ -1,3 +1,5 @@
+namespace lemon {
+
/**
\page basic_concepts Basic concepts
@@ -117,3 +119,5 @@
As you see ListGraph satisfies most of the basic concepts and ideal for general
graph representations. It has an undirected version too: ListUGraph.
*/
+
+}
\ No newline at end of file
Modified: hugo/trunk/doc/dirs.dox
==============================================================================
--- hugo/trunk/doc/dirs.dox (original)
+++ hugo/trunk/doc/dirs.dox Tue Jan 23 13:51:39 2007
@@ -37,7 +37,7 @@
*/
/**
-\dir concept
+\dir concepts
\brief Concept descriptors and checking classes
This directory contains the concept descriptors and concept checkers. As a user
Modified: hugo/trunk/doc/groups.dox
==============================================================================
--- hugo/trunk/doc/groups.dox (original)
+++ hugo/trunk/doc/groups.dox Tue Jan 23 13:51:39 2007
@@ -134,11 +134,11 @@
*/
/**
- at defgroup gutils General Graph Utilities
+ at defgroup gutils Basic Graph Utilities
@ingroup algs
-\brief This group describes some simple general graph utilities.
+\brief This group describes some simple basic graph utilities.
-This group describes some simple general graph utilities.
+This group describes some simple basic graph utilities.
*/
/**
Modified: hugo/trunk/lemon/bfs.h
==============================================================================
--- hugo/trunk/lemon/bfs.h (original)
+++ hugo/trunk/lemon/bfs.h Tue Jan 23 13:51:39 2007
@@ -520,7 +520,7 @@
///reached parameter will be set true. The reached parameter
///should be initially false.
///
- ///\param target The nodemaps of possible targets.
+ ///\param nm The nodemaps of possible targets.
///\retval reached Indicates that one of the target nodes is reached.
///\return The processed node.
///
@@ -617,7 +617,7 @@
///
///\param nm must be a bool (or convertible) node map. The
///algorithm will stop when it reached a node \c v with
- ///<tt>nm[v]</tt> true.
+ /// <tt>nm[v]</tt> true.
///\todo query the reached target
template<class NM>
void start(const NM &nm)
@@ -1435,7 +1435,7 @@
/// reached parameter will be set true. The reached parameter
/// should be initially false.
///
- /// \param target The nodemaps of possible targets.
+ /// \param nm The nodemaps of possible targets.
/// \retval reached Indicates that one of the target nodes is reached.
/// \return The processed node.
///
@@ -1514,7 +1514,7 @@
///
///\param nm must be a bool (or convertible) node map. The
///algorithm will stop when it reached a node \c v with
- ///<tt>nm[v]</tt> true.
+ /// <tt>nm[v]</tt> true.
template <typename NM>
void start(const NM &nm) {
bool reached = false;
Modified: hugo/trunk/lemon/elevator.h
==============================================================================
--- hugo/trunk/lemon/elevator.h (original)
+++ hugo/trunk/lemon/elevator.h Tue Jan 23 13:51:39 2007
@@ -266,8 +266,8 @@
///Lift an active item to a higher level.
///Lift an active item to a higher level.
- ///\params i The item to be lifted. It must be active.
- ///\params new_level The new level of \c i. It must be strictly higher
+ ///\param i The item to be lifted. It must be active.
+ ///\param new_level The new level of \c i. It must be strictly higher
///than the current level.
///
void liftTo(Item i, int new_level)
Modified: hugo/trunk/lemon/eps.h
==============================================================================
--- hugo/trunk/lemon/eps.h (original)
+++ hugo/trunk/lemon/eps.h Tue Jan 23 13:51:39 2007
@@ -283,6 +283,7 @@
///\param t The shape of the drawn object
///\param x The \c x coordinate of the node
///\param y The \c y coordinate of the node
+ ///\param r The size (radius) of the node
///\param col Color of the node. The default color is white
///\param brd Color of the node border. The default color is black
EpsDrawer &node(NodeShapes t, double x, double y, double r,
@@ -293,6 +294,7 @@
///
///\param t The shape of the drawn object
///\param pos Position of the node
+ ///\param r The size (radius) of the node
///\param col Color of the node. The default color is white
///\param brd Color of the node border. The default color is black
template<class T>
Modified: hugo/trunk/lemon/euler.h
==============================================================================
--- hugo/trunk/lemon/euler.h (original)
+++ hugo/trunk/lemon/euler.h Tue Jan 23 13:51:39 2007
@@ -121,9 +121,9 @@
///Euler iterator for undirected graphs.
/// \ingroup topology
- ///This iterator converts to the \c Edge (or \cUEdge)
+ ///This iterator converts to the \c Edge (or \c UEdge)
///type of the graph and using
- ///operator ++ it provides an Euler tour of an \undirected
+ ///operator ++ it provides an Euler tour of an undirected
///graph (if there exists).
///
///For example
Modified: hugo/trunk/lemon/graph_utils.h
==============================================================================
--- hugo/trunk/lemon/graph_utils.h (original)
+++ hugo/trunk/lemon/graph_utils.h Tue Jan 23 13:51:39 2007
@@ -397,7 +397,7 @@
///
///\sa findEdge()
///\sa EdgeLookUp
- ///\se AllEdgeLookup
+ ///\sa AllEdgeLookup
///
/// \author Balazs Dezso
template <typename _Graph>
@@ -2661,7 +2661,7 @@
///\param t The target node
///\param prev The previous edge between \c s and \c t. It it is INVALID or
///not given, the operator finds the first appropriate edge.
- ///\return An edge from \c s to \c t after \prev or
+ ///\return An edge from \c s to \c t after \c prev or
///\ref INVALID if there is no more.
///
///For example, you can count the number of edges from \c u to \c v in the
Modified: hugo/trunk/lemon/path_utils.h
==============================================================================
--- hugo/trunk/lemon/path_utils.h (original)
+++ hugo/trunk/lemon/path_utils.h Tue Jan 23 13:51:39 2007
@@ -103,9 +103,7 @@
/// \brief Checks the path's consistency.
///
/// Checks that each edge's target is the next's source.
- /// \Checks the path's consistency.
- ///
- /// Checks that each edge's target is the next's source.
+ ///
template <typename Graph, typename Path>
bool checkPath(const Graph& graph, const Path& path) {
typename Path::EdgeIt it(path);
Modified: hugo/trunk/lemon/preflow.h
==============================================================================
--- hugo/trunk/lemon/preflow.h (original)
+++ hugo/trunk/lemon/preflow.h Tue Jan 23 13:51:39 2007
@@ -155,7 +155,7 @@
///\param _t The target node.
///\param _cap The capacity of the edges.
///\param _f The flow of the edges.
- ///\param tol Tolerance class.
+ ///\param _sr Tolerance class.
///Except the graph, all of these parameters can be reset by
///calling \ref source, \ref target, \ref capacityMap and \ref
///flowMap, resp.
Modified: hugo/trunk/lemon/smart_graph.h
==============================================================================
--- hugo/trunk/lemon/smart_graph.h (original)
+++ hugo/trunk/lemon/smart_graph.h Tue Jan 23 13:51:39 2007
@@ -693,7 +693,7 @@
///Constructor that immediately makes a snapshot
///This constructor immediately makes a snapshot of the graph.
- ///\param _g The graph we make a snapshot of.
+ ///\param g The graph we make a snapshot of.
Snapshot(SmartUGraph &g) {
g.saveSnapshot(*this);
}
@@ -704,7 +704,7 @@
///
///This function can be called more than once. In case of a repeated
///call, the previous snapshot gets lost.
- ///\param _g The graph we make the snapshot of.
+ ///\param g The graph we make the snapshot of.
void save(SmartUGraph &g)
{
g.saveSnapshot(*this);
Modified: hugo/trunk/lemon/ssp_min_cost_flow.h
==============================================================================
--- hugo/trunk/lemon/ssp_min_cost_flow.h (original)
+++ hugo/trunk/lemon/ssp_min_cost_flow.h Tue Jan 23 13:51:39 2007
@@ -21,7 +21,8 @@
///\ingroup flowalgs
///
-///\file \brief An algorithm for finding a flow of value \c k (for
+///\file
+///\brief An algorithm for finding a flow of value \c k (for
///small values of \c k) having minimal total cost
More information about the Lemon-commits
mailing list