Changeset 1713:49d22d34d95f in lemon-0.x for doc/named-param.dox

Timestamp:

10/06/05 12:28:45 (19 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Doc improvments

File:

• doc/named-param.dox (modified) (5 diffs)

doc/named-param.dox

@@ -22 +22 @@
 
 \code
-class named_fn 
+class namedFn 
 {
   int _id;
@@ -29 +29 @@
   
   public:
-  named_fn() : _id(0), _val(1), _dim(2) {}
-  named_fn& id(int p)     { _id  = p ; return *this; }
-  named_fn& val(double p) { _val = p ; return *this; }
-  named_fn& dim(int p)    { _dim = p ; return *this; }
+  namedFn() : _id(0), _val(1), _dim(2) {}
+  namedFn& id(int p)     { _id  = p ; return *this; }
+  namedFn& val(double p) { _val = p ; return *this; }
+  namedFn& dim(int p)    { _dim = p ; return *this; }
 
   run() {
@@ -43 +43 @@
 The usage is the following.
 
-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
+We have to define a class, let's call it \c namedFn.  Let us assume that
+we would like to use a parameter, called \c X. In the \c namedFn 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
@@ -56 +56 @@
 attributes (originally the parameters), initially. If we call function
 \c X, we get a class with the modified parameter value of
-\c X. Therefore we can modify any parameter-value, independent from the
+\c X. Therefore we can modify any parameter-value, independently from the
 order. To run the algorithm we have to call the <tt>run()</tt> function at the
 end of the row.
@@ -62 +62 @@
 Example:
 \code
-named_fn().id(3).val(2).run();
+namedFn().id(3).val(2).run();
 \endcode
+
+\note Although it is a class, namedFn is used pretty much like as it were
+a function. That it why it is called namedFn and not \c NamedFn.
+
+\note In fact, the final <tt>.run()</tt> could be made unnecessary if the
+actual function code were put in the destructor instead. This however would make
+hard to implement functions with return values, and would also make the
+implementation of \ref named-templ-func-param "named template parameters"
+very problematic. Therefore, by convention, <tt>.run()</tt> is used
+to explicitly execute function having named parameters in Lemon. 
+
 
 \section traits-classes Traits Classes