[Lemon-commits] [lemon_svn] alpar: r2132 - in hugo/trunk: doc lemon lemon/concept

[Lemon SVN]

Author: alpar
Date: Thu Aug 11 16:31:06 2005
New Revision: 2132

Modified:
   hugo/trunk/doc/named-param.dox
   hugo/trunk/lemon/bfs.h
   hugo/trunk/lemon/concept/graph.h
   hugo/trunk/lemon/concept/path.h
   hugo/trunk/lemon/concept/undir_graph.h

Log:
Several docfices

Modified: hugo/trunk/doc/named-param.dox
==============================================================================
--- hugo/trunk/doc/named-param.dox	(original)
+++ hugo/trunk/doc/named-param.dox	Thu Aug 11 16:31:06 2005
@@ -1,8 +1,8 @@
-*!
+/*!
 
 \page named-param Named Parameters
 
-\section named-func-param Named "Function" Parameters
+\section named-func-param Named Function Parameters
 
 C++ makes it possible to use default parameter values when calling a
 function. In such a case we do not have to give value for parameters,
@@ -42,24 +42,27 @@
 
 The usage is the following.
 
-We have to define a class, let's call it named_fn.  Let us assume that
-we would like to use a parameter, called X. In the named_fn class we
-have to define an _X attribute, and a function X. The function
-expects a parameter with the type of _X, and sets the value of
-_X. After setting the value the function returns the class itself. The
-class also have to have a function, called for example run(), we have
+We have to define a class, let's call it \c named_fn.  Let us assume that
+we would like to use a parameter, called \c X. In the \c named_fn class we
+have to define an \c _X attribute, and a function \c X. The function
+expects a parameter with the type of \c _X, and sets the value of
+\c _X. After setting the value the function returns the class itself. The
+class also have to have a function, called for example <tt>run()</tt>, we have
 to implement here the original function itself. The constructor of the
-class have to give all the attributes like _X the default values of
+class have to give all the attributes like \c _X the default values of
 them.
 
 If we instantiate this class, the default values will be set for the
 attributes (originally the parameters), initially. If we call function
-X, we get a class with the modified parameter value of
-X. Therefore we can modify any parameter-value, independent from the
-order. To run the algorithm we have to call the run() function at the
+\c X, we get a class with the modified parameter value of
+\c X. Therefore we can modify any parameter-value, independent from the
+order. To run the algorithm we have to call the <tt>run()</tt> function at the
 end of the row.
 
-Example: named_fn().id(3).val(2).run();
+Example:
+\code
+named_fn().id(3).val(2).run();
+\endcode
 
 \section traits-classes Traits Classes
 
@@ -92,7 +95,7 @@
 The result will be an instantiated Dijkstra class, in which the
 DistMap and the PredMap is modified.
 
-\section named-templ-func-param Named "Function" Template Parameters
+\section named-templ-func-param Named Function Template Parameters
 
 If the class has so called wizard functions, the new class with the
 modified tpye of attributes can be returned by the appropriate wizard

Modified: hugo/trunk/lemon/bfs.h
==============================================================================
--- hugo/trunk/lemon/bfs.h	(original)
+++ hugo/trunk/lemon/bfs.h	Thu Aug 11 16:31:06 2005
@@ -265,8 +265,7 @@
     ///\ref named-templ-param "Named parameter" for setting PredMap type
     ///
     template <class T>
-    class DefPredMap : public Bfs< Graph,
-					DefPredMapTraits<T> > { };
+    class DefPredMap : public Bfs< Graph, DefPredMapTraits<T> > { };
     
 //     template <class T>
 //     struct DefPredNodeMapTraits : public Traits {

Modified: hugo/trunk/lemon/concept/graph.h
==============================================================================
--- hugo/trunk/lemon/concept/graph.h	(original)
+++ hugo/trunk/lemon/concept/graph.h	Thu Aug 11 16:31:06 2005
@@ -314,8 +314,6 @@
     
         /// This constructor sets the iterator to the first outgoing edge of
         /// the node.
-        ///@param n the node
-        ///@param g the graph
         OutEdgeIt(const StaticGraph&, const Node&) { }
         /// Edge -> OutEdgeIt conversion
 
@@ -363,8 +361,6 @@
     
         /// This constructor set the iterator to the first incoming edge of
         /// the node.
-        ///@param n the node
-        ///@param g the graph
         InEdgeIt(const StaticGraph&, const Node&) { }
         /// Edge -> InEdgeIt conversion
 

Modified: hugo/trunk/lemon/concept/path.h
==============================================================================
--- hugo/trunk/lemon/concept/path.h	(original)
+++ hugo/trunk/lemon/concept/path.h	Thu Aug 11 16:31:06 2005
@@ -52,9 +52,9 @@
       class NodeIt;
       class EdgeIt;
 
-      /// \param _G The graph in which the path is.
+      /// \param _g The graph in which the path is.
       ///
-      Path(const Graph &) {}
+      Path(const Graph &_g) {}
 
       /// Length of the path.
       int length() const {return 0;}
@@ -181,7 +181,7 @@
 
         Path &P;
 
-	///\param _P the path you want to fill in.
+	///\param _p the path you want to fill in.
 	///
 
 	Builder(Path &_p) : P(_p) {}

Modified: hugo/trunk/lemon/concept/undir_graph.h
==============================================================================
--- hugo/trunk/lemon/concept/undir_graph.h	(original)
+++ hugo/trunk/lemon/concept/undir_graph.h	Thu Aug 11 16:31:06 2005
@@ -314,7 +314,6 @@
         /// This constructor sets the iterator to the first edge.
     
         /// This constructor sets the iterator to the first edge of \c g.
-        ///@param g the graph
         UndirEdgeIt(const UndirGraph&) { }
         /// UndirEdge -> UndirEdgeIt conversion
 
@@ -362,8 +361,6 @@
     
         /// This constructor set the iterator to the first incident edge of
         /// the node.
-        ///@param n the node
-        ///@param g the graph
         IncEdgeIt(const UndirGraph&, const Node&) { }
         /// UndirEdge -> IncEdgeIt conversion