diff -r c3defc3590aa -r 61cc647dac99 doc/named-param.dox
--- a/doc/named-param.dox Thu Aug 11 13:20:52 2005 +0000
+++ b/doc/named-param.dox Thu Aug 11 14:31:06 2005 +0000
@@ -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 run(), 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 run() 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