From: kanschat <kanschat@0785d39b-7218-0410-832d-ea1e28bc413d>
Date: Wed, 11 Jun 2014 09:23:31 +0000 (+0000)
Subject: improve documentation
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4c90ca8e4dfd53a77e6d0222362ace003ffafa98;p=dealii-svn.git

improve documentation

git-svn-id: https://svn.dealii.org/trunk@33029 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/include/deal.II/algorithms/theta_timestepping.h b/deal.II/include/deal.II/algorithms/theta_timestepping.h
index ff6262cbab..d6fafbb8ba 100644
--- a/deal.II/include/deal.II/algorithms/theta_timestepping.h
+++ b/deal.II/include/deal.II/algorithms/theta_timestepping.h
@@ -95,15 +95,15 @@ namespace Algorithms
    * <h4>Vector data</h4>
    *
    * The explicit Operator #op_explicit receives in its input in first
-   * place the vector <tt>"Previous iterate"</tt>, which is the solution
+   * place the vector "Previous iterate", which is the solution
    * value after the previous timestep. It is followed by all vectors
    * provided to ThetaTimestepping::operator() as input
    * argument. #op_explicit is supposed to write its result into the
-   * first position of its output argument, labeled <tt>"Result"</tt>.
+   * first position of its output argument, labeled "Result".
    *
    * The implicit Operator #op_implicit receives the result of
-   * #op_explicit in its first input vector labeled <tt>"Previous
-   * time"</tt>. It is followed by all vectors provided to
+   * #op_explicit in its first input vector labeled "Previous
+   * time". It is followed by all vectors provided to
    * ThetaTimestepping::operator() as input argument. The output of
    * #op_implicit is directly written into the output argument given to
    * ThetaTimestepping.
@@ -114,7 +114,7 @@ namespace Algorithms
    * communicate the current time step information through AnyData as
    * well. Therefore, the AnyData objects handed as input to
    * #op_explicit and #op_implicit contain two entries of type
-   * <tt>const double*</tt> named "Time" and "Timestep". Note
+   * `const double*` named "Time" and "Timestep". Note
    * that "Time" refers to the time at the beginning of the current
    * step for #op_explicit and at the end for #op_implicit,
    * respectively.
@@ -217,9 +217,15 @@ namespace Algorithms
                        Operator<VECTOR> &op_implicit);
 
     /**
-     * The timestepping scheme. <tt>in</tt>
-     * should contain the initial
-     * value in first position. <tt>out</tt>
+     * The timestepping scheme.
+     *
+     * @param `in` is ignored by
+     * ThetaTimestepping, but is merged into the AnyData objects used
+     * as input for the operators #op_explicit and #op_implicit.
+     *
+     * @param `out` in its first argument must contain a pointer to a
+     * `VECTOR`, which contains the initial value when the operator is
+     * called. It contains the final value when the operator returns.
      */
     virtual void operator() (AnyData &out, const AnyData &in);