]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Fix up a few doxygen tags.
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 1 May 2008 02:23:55 +0000 (02:23 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 1 May 2008 02:23:55 +0000 (02:23 +0000)
git-svn-id: https://svn.dealii.org/trunk@16022 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/convergence_table.h

index 401ff0f1d1ac277274a15df605a8724499b88b9f..8ea48c34c424ed142aa56c91c0de54a1fc15959f 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors
+//    Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2008 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -108,21 +108,21 @@ class ConvergenceTable: public TableHandler
                                      * 
                                      * If RateMode is reduction_rate, then the computed
                                      * output is 
-                                     * \f[ \frac{e_{n-1}/k_{n-1}}{e_n/k_n} \f].
+                                     * $ \frac{e_{n-1}/k_{n-1}}{e_n/k_n} $.
                                      *
-                                     * Where \f$k\f$ is the reference column.
+                                     * Where $k$ is the reference column.
                                      *
                                      * If RateMode is reduction_rate_log2, then the 
-                                     * computed output is:
-                                     * \f[ 
+                                     * computed output is
+                                     * $
                                      * 2\frac{\log |e_{n-1}/e_{n}|}{\log |k_n/k_{n-1}|} 
-                                     * \f].
+                                     * $.
                                      *
                                      * This is useful, for example, if we use as 
                                      * reference key the number of degrees of freedom. 
                                      * Assuming that the error is proportional to 
-                                     * \f$ C (1/\sqrt{k})^r \f$, then this method will 
-                                     * produce the rate \f$ r \f$ as a result.
+                                     * $ C (1/\sqrt{k})^r $, then this method will 
+                                     * produce the rate $r$ as a result.
                                      */
     void
     evaluate_convergence_rates (const std::string &data_column_key,

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.