]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
documentation fixes
authorheister <heister@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 24 Feb 2014 19:37:48 +0000 (19:37 +0000)
committerheister <heister@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 24 Feb 2014 19:37:48 +0000 (19:37 +0000)
git-svn-id: https://svn.dealii.org/branches/branch_muparser@32544 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/include/deal.II/base/function_parser.h

index 0bc81fb36b75c4478c6f2deca1382cc70a162baa..fd4800ae14c96a8d676e7fd6e088bd6b2fcd5b69 100644 (file)
@@ -193,16 +193,17 @@ template <typename> class Vector;
  *  "x-1"
  *  "-sin(sqrt(x^2+y^2))"
  *  "sqrt(XCoord*XCoord + YCoord*YCoord)"
- *
  * @endverbatim
  *
+ * For a wrapper of the FunctionParser class that supports ParameterHandler,
+ * see ParsedFunction.
+ *
  * Vector-valued functions can either be declared using strings where the
  * function components are separated by semicolons, or using a vector of
  * strings each defining one vector component.
  *
  * An example of time dependent scalar function is the following:
  * @code
- *
  *    // Empty constants object
  *    std::map<std::string> constants;
  *
@@ -223,13 +224,11 @@ template <typename> class Vector;
  *                                      // it is a time-dependent function
  *                                      // and there is another variable
  *                                      // to be taken into account (t).
- *
  * @endcode
  *
  * The following is another example of how to instantiate a vector valued
  * function by using a single string:
  * @code
- *
  *    // Empty constants object
  *    std::map<std::string> constants;
  *
@@ -246,7 +245,6 @@ template <typename> class Vector;
  *    function.initialize(variables,
  *                        expression,
  *                        constants);
- *
  * @endcode
  *
  *

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.