Context Navigation

Changeset 2350:eb371753e814 in lemon-0.x

Timestamp:

01/23/07 13:51:39 (18 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Several doc improvements.

Files:

-                      r2209
+                      r2350
 ///\ingroup demos
 ///\file maps_summary demo program
 ///\brief Introduction to LEMON maps
+///\file
+///\brief An introduction to LEMON maps
 ///
 /// \include maps_summary.cc

-                      r2288
+                      r2350
+namespace lemon {
 /**
 \page basic_concepts Basic concepts
 …
 graph representations. It has an undirected version too: ListUGraph.
 */
+}

r2157	r2350
38	38
39	39	/**
40		\dir concept
	40	\dir concepts
41	41	\brief Concept descriptors and checking classes
42	42

-                      r2260
+                      r2350
 /**
 @defgroup gutils General Graph Utilities
 @ingroup algs
 \brief This group describes some simple general graph utilities.
 This group describes some simple general graph utilities.
+@defgroup gutils Basic Graph Utilities
+@ingroup algs
+\brief This group describes some simple basic graph utilities.
+This group describes some simple basic graph utilities.
 */

-                      r2335
+                      r2350
     ///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.
 …
     ///\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>
 …
     /// 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.
 …
     ///\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) {

-                      r2349
+                      r2350
     ///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.
     ///

-                      r2214
+                      r2350
     ///\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
 …
     ///\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

-                      r1993
+                      r2350
   /// \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).
   ///

-                      r2331
+                      r2350
   ///\sa findEdge()
   ///\sa EdgeLookUp
   ///\se AllEdgeLookup
+  ///\sa AllEdgeLookup
   ///
   /// \author Balazs Dezso
 …
     ///\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.
     ///

-                      r2335
+                      r2350
   ///
   /// 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) {

r2330	r2350
156	156	///\param _cap The capacity of the edges.
157	157	///\param _f The flow of the edges.
158		///\param ~~tol~~ Tolerance class.
	158	///\param _sr Tolerance class.
159	159	///Except the graph, all of these parameters can be reset by
160	160	///calling \ref source, \ref target, \ref capacityMap and \ref

-                      r2343
+                      r2350
       ///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);
 …
       ///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)
+      {

-                      r2276
+                      r2350
 ///\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

Note: See TracChangeset for help on using the changeset viewer.