Several doc improvements.
1.1 --- a/demo/maps_summary.cc Mon Jan 22 12:13:57 2007 +0000
1.2 +++ b/demo/maps_summary.cc Tue Jan 23 12:51:39 2007 +0000
1.3 @@ -17,8 +17,8 @@
1.4 */
1.5
1.6 ///\ingroup demos
1.7 -///\file maps_summary demo program
1.8 -///\brief Introduction to LEMON maps
1.9 +///\file
1.10 +///\brief An introduction to LEMON maps
1.11 ///
1.12 /// \include maps_summary.cc
1.13
2.1 --- a/doc/basic_concepts.dox Mon Jan 22 12:13:57 2007 +0000
2.2 +++ b/doc/basic_concepts.dox Tue Jan 23 12:51:39 2007 +0000
2.3 @@ -1,3 +1,5 @@
2.4 +namespace lemon {
2.5 +
2.6 /**
2.7 \page basic_concepts Basic concepts
2.8
2.9 @@ -117,3 +119,5 @@
2.10 As you see ListGraph satisfies most of the basic concepts and ideal for general
2.11 graph representations. It has an undirected version too: ListUGraph.
2.12 */
2.13 +
2.14 +}
2.15 \ No newline at end of file
3.1 --- a/doc/dirs.dox Mon Jan 22 12:13:57 2007 +0000
3.2 +++ b/doc/dirs.dox Tue Jan 23 12:51:39 2007 +0000
3.3 @@ -37,7 +37,7 @@
3.4 */
3.5
3.6 /**
3.7 -\dir concept
3.8 +\dir concepts
3.9 \brief Concept descriptors and checking classes
3.10
3.11 This directory contains the concept descriptors and concept checkers. As a user
4.1 --- a/doc/groups.dox Mon Jan 22 12:13:57 2007 +0000
4.2 +++ b/doc/groups.dox Tue Jan 23 12:51:39 2007 +0000
4.3 @@ -134,11 +134,11 @@
4.4 */
4.5
4.6 /**
4.7 -@defgroup gutils General Graph Utilities
4.8 +@defgroup gutils Basic Graph Utilities
4.9 @ingroup algs
4.10 -\brief This group describes some simple general graph utilities.
4.11 +\brief This group describes some simple basic graph utilities.
4.12
4.13 -This group describes some simple general graph utilities.
4.14 +This group describes some simple basic graph utilities.
4.15 */
4.16
4.17 /**
5.1 --- a/lemon/bfs.h Mon Jan 22 12:13:57 2007 +0000
5.2 +++ b/lemon/bfs.h Tue Jan 23 12:51:39 2007 +0000
5.3 @@ -520,7 +520,7 @@
5.4 ///reached parameter will be set true. The reached parameter
5.5 ///should be initially false.
5.6 ///
5.7 - ///\param target The nodemaps of possible targets.
5.8 + ///\param nm The nodemaps of possible targets.
5.9 ///\retval reached Indicates that one of the target nodes is reached.
5.10 ///\return The processed node.
5.11 ///
5.12 @@ -617,7 +617,7 @@
5.13 ///
5.14 ///\param nm must be a bool (or convertible) node map. The
5.15 ///algorithm will stop when it reached a node \c v with
5.16 - ///<tt>nm[v]</tt> true.
5.17 + /// <tt>nm[v]</tt> true.
5.18 ///\todo query the reached target
5.19 template<class NM>
5.20 void start(const NM &nm)
5.21 @@ -1435,7 +1435,7 @@
5.22 /// reached parameter will be set true. The reached parameter
5.23 /// should be initially false.
5.24 ///
5.25 - /// \param target The nodemaps of possible targets.
5.26 + /// \param nm The nodemaps of possible targets.
5.27 /// \retval reached Indicates that one of the target nodes is reached.
5.28 /// \return The processed node.
5.29 ///
5.30 @@ -1514,7 +1514,7 @@
5.31 ///
5.32 ///\param nm must be a bool (or convertible) node map. The
5.33 ///algorithm will stop when it reached a node \c v with
5.34 - ///<tt>nm[v]</tt> true.
5.35 + /// <tt>nm[v]</tt> true.
5.36 template <typename NM>
5.37 void start(const NM &nm) {
5.38 bool reached = false;
6.1 --- a/lemon/elevator.h Mon Jan 22 12:13:57 2007 +0000
6.2 +++ b/lemon/elevator.h Tue Jan 23 12:51:39 2007 +0000
6.3 @@ -266,8 +266,8 @@
6.4 ///Lift an active item to a higher level.
6.5
6.6 ///Lift an active item to a higher level.
6.7 - ///\params i The item to be lifted. It must be active.
6.8 - ///\params new_level The new level of \c i. It must be strictly higher
6.9 + ///\param i The item to be lifted. It must be active.
6.10 + ///\param new_level The new level of \c i. It must be strictly higher
6.11 ///than the current level.
6.12 ///
6.13 void liftTo(Item i, int new_level)
7.1 --- a/lemon/eps.h Mon Jan 22 12:13:57 2007 +0000
7.2 +++ b/lemon/eps.h Tue Jan 23 12:51:39 2007 +0000
7.3 @@ -283,6 +283,7 @@
7.4 ///\param t The shape of the drawn object
7.5 ///\param x The \c x coordinate of the node
7.6 ///\param y The \c y coordinate of the node
7.7 + ///\param r The size (radius) of the node
7.8 ///\param col Color of the node. The default color is white
7.9 ///\param brd Color of the node border. The default color is black
7.10 EpsDrawer &node(NodeShapes t, double x, double y, double r,
7.11 @@ -293,6 +294,7 @@
7.12 ///
7.13 ///\param t The shape of the drawn object
7.14 ///\param pos Position of the node
7.15 + ///\param r The size (radius) of the node
7.16 ///\param col Color of the node. The default color is white
7.17 ///\param brd Color of the node border. The default color is black
7.18 template<class T>
8.1 --- a/lemon/euler.h Mon Jan 22 12:13:57 2007 +0000
8.2 +++ b/lemon/euler.h Tue Jan 23 12:51:39 2007 +0000
8.3 @@ -121,9 +121,9 @@
8.4 ///Euler iterator for undirected graphs.
8.5
8.6 /// \ingroup topology
8.7 - ///This iterator converts to the \c Edge (or \cUEdge)
8.8 + ///This iterator converts to the \c Edge (or \c UEdge)
8.9 ///type of the graph and using
8.10 - ///operator ++ it provides an Euler tour of an \undirected
8.11 + ///operator ++ it provides an Euler tour of an undirected
8.12 ///graph (if there exists).
8.13 ///
8.14 ///For example
9.1 --- a/lemon/graph_utils.h Mon Jan 22 12:13:57 2007 +0000
9.2 +++ b/lemon/graph_utils.h Tue Jan 23 12:51:39 2007 +0000
9.3 @@ -397,7 +397,7 @@
9.4 ///
9.5 ///\sa findEdge()
9.6 ///\sa EdgeLookUp
9.7 - ///\se AllEdgeLookup
9.8 + ///\sa AllEdgeLookup
9.9 ///
9.10 /// \author Balazs Dezso
9.11 template <typename _Graph>
9.12 @@ -2661,7 +2661,7 @@
9.13 ///\param t The target node
9.14 ///\param prev The previous edge between \c s and \c t. It it is INVALID or
9.15 ///not given, the operator finds the first appropriate edge.
9.16 - ///\return An edge from \c s to \c t after \prev or
9.17 + ///\return An edge from \c s to \c t after \c prev or
9.18 ///\ref INVALID if there is no more.
9.19 ///
9.20 ///For example, you can count the number of edges from \c u to \c v in the
10.1 --- a/lemon/path_utils.h Mon Jan 22 12:13:57 2007 +0000
10.2 +++ b/lemon/path_utils.h Tue Jan 23 12:51:39 2007 +0000
10.3 @@ -103,9 +103,7 @@
10.4 /// \brief Checks the path's consistency.
10.5 ///
10.6 /// Checks that each edge's target is the next's source.
10.7 - /// \Checks the path's consistency.
10.8 - ///
10.9 - /// Checks that each edge's target is the next's source.
10.10 + ///
10.11 template <typename Graph, typename Path>
10.12 bool checkPath(const Graph& graph, const Path& path) {
10.13 typename Path::EdgeIt it(path);
11.1 --- a/lemon/preflow.h Mon Jan 22 12:13:57 2007 +0000
11.2 +++ b/lemon/preflow.h Tue Jan 23 12:51:39 2007 +0000
11.3 @@ -155,7 +155,7 @@
11.4 ///\param _t The target node.
11.5 ///\param _cap The capacity of the edges.
11.6 ///\param _f The flow of the edges.
11.7 - ///\param tol Tolerance class.
11.8 + ///\param _sr Tolerance class.
11.9 ///Except the graph, all of these parameters can be reset by
11.10 ///calling \ref source, \ref target, \ref capacityMap and \ref
11.11 ///flowMap, resp.
12.1 --- a/lemon/smart_graph.h Mon Jan 22 12:13:57 2007 +0000
12.2 +++ b/lemon/smart_graph.h Tue Jan 23 12:51:39 2007 +0000
12.3 @@ -693,7 +693,7 @@
12.4 ///Constructor that immediately makes a snapshot
12.5
12.6 ///This constructor immediately makes a snapshot of the graph.
12.7 - ///\param _g The graph we make a snapshot of.
12.8 + ///\param g The graph we make a snapshot of.
12.9 Snapshot(SmartUGraph &g) {
12.10 g.saveSnapshot(*this);
12.11 }
12.12 @@ -704,7 +704,7 @@
12.13 ///
12.14 ///This function can be called more than once. In case of a repeated
12.15 ///call, the previous snapshot gets lost.
12.16 - ///\param _g The graph we make the snapshot of.
12.17 + ///\param g The graph we make the snapshot of.
12.18 void save(SmartUGraph &g)
12.19 {
12.20 g.saveSnapshot(*this);
13.1 --- a/lemon/ssp_min_cost_flow.h Mon Jan 22 12:13:57 2007 +0000
13.2 +++ b/lemon/ssp_min_cost_flow.h Tue Jan 23 12:51:39 2007 +0000
13.3 @@ -21,7 +21,8 @@
13.4
13.5 ///\ingroup flowalgs
13.6 ///
13.7 -///\file \brief An algorithm for finding a flow of value \c k (for
13.8 +///\file
13.9 +///\brief An algorithm for finding a flow of value \c k (for
13.10 ///small values of \c k) having minimal total cost
13.11
13.12