From: Wolfgang Bangerth <bangerth@math.tamu.edu>
Date: Sat, 13 Dec 2014 03:50:47 +0000 (-0600)
Subject: Clean up documentation a bit.
X-Git-Tag: v8.2.0-rc1~15^2~1
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9043cc76b79aa83f57f97170affc390a533ce792;p=dealii.git

Clean up documentation a bit.
---

diff --git a/include/deal.II/base/function_parser.h b/include/deal.II/base/function_parser.h
index 9296dbb68c..2a7417a1ed 100644
--- a/include/deal.II/base/function_parser.h
+++ b/include/deal.II/base/function_parser.h
@@ -364,29 +364,39 @@ public:
 private:
 #ifdef DEAL_II_WITH_MUPARSER
   /**
-   * place for the variables for each thread
+   * Place for the variables for each thread
    */
   mutable Threads::ThreadLocalStorage<std::vector<double> > vars;
+
   /**
-   * the muParser objects for each thread (and one for each component)
+   * The muParser objects for each thread (and one for each component)
    */
   mutable Threads::ThreadLocalStorage<std::vector<mu::Parser> > fp;
 
   /**
-   * keep track of all the constants, required to initialize fp in each
-   * thread
+   * An array to keep track of all the constants, required to
+   * initialize fp in each thread.
    */
   std::map<std::string, double> constants;
+
   /**
-   * variable names, required to initialize fp in each thread
+   * An array for the variable names, required to initialize fp in
+   * each thread.
    */
   std::vector<std::string> var_names;
+
   /**
-   * the expressions, required to initialize fp in each thread
+   * An array of function expressions (one per component), required to
+   * initialize fp in each thread.
    */
   std::vector<std::string> expressions;
+
   /**
-   * this function will initialize fp on the current thread
+   * Initialize fp and vars on the current thread. This function may
+   * only be called once per thread. A thread can test whether the
+   * function has already been called by testing whether
+   * 'fp.get().size()==0' (not initialized) or >0 (already
+   * initialized).
    */
   void init_muparser() const;
 #endif