From: Timo Heister <timo.heister@gmail.com>
Date: Tue, 27 Nov 2018 17:18:34 +0000 (-0500)
Subject: docs: TableHandler fixes
X-Git-Tag: v9.1.0-rc1~528^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F7478%2Fhead;p=dealii.git

docs: TableHandler fixes
---

diff --git a/include/deal.II/base/table_handler.h b/include/deal.II/base/table_handler.h
index 2b59adef94..42e16a1149 100644
--- a/include/deal.II/base/table_handler.h
+++ b/include/deal.II/base/table_handler.h
@@ -229,16 +229,23 @@ namespace internal
  * To support both scenarios, the TableHandler class has a property called <i
  * >auto-fill mode</i>. By default, auto-fill mode is off, but it can be
  * enabled by calling set_auto_fill_mode(). If auto-fill mode is enabled we
- * use the following algorithm: - When calling <code>add_value(key,
- * value)</code>, we count the number of elements in the column corresponding
- * to <code>key</code>. Let's call this number $m$. - We also determine the
- * maximal number of elements in the other columns; call it $n$. - If $m <
- * n-1$ then we add $n-m-1$ copies of the object <code>T()</code> to this
- * column. Here, <code>T</code> is the data type of the given
+ * use the following algorithm:
+ *
+ * - When calling <code>add_value(key, value)</code>, we count the number of
+ * elements in the column corresponding to <code>key</code>. Let's call this
+ * number $m$.
+ *
+ * - We also determine the maximal number of elements in the other columns;
+ * call it $n$.
+ *
+ * - If $m < n-1$ then we add $n-m-1$ copies of the object <code>T()</code> to
+ * this column. Here, <code>T</code> is the data type of the given
  * <code>value</code>. For example, if <code>T</code> is a numeric type, then
  * <code>T()</code> is the number zero; if <code>T</code> is
  * <code>std::string</code>, then <code>T()</code> is the empty string
- * <code>""</code>. - Add the given value to this column.
+ * <code>""</code>.
+ *
+ * - Add the given value to this column.
  *
  * Padding the column with default elements makes sure that after the addition
  * the column has as many entries as the longest other column. In other words,
@@ -509,7 +516,7 @@ public:
    * then the entry of the table is printed as <code>""</code>.
    *
    * The second argument indicates how column keys are to be displayed. See
-   * the description of TextOutputFormat for more information
+   * the description of TextOutputFormat for more information.
    */
   void
   write_text(std::ostream &         out,
@@ -720,7 +727,7 @@ protected:
    *
    * The field is declared mutable so that the write_text() and write_tex()
    * functions can be const, even though they may pad columns below if
-   * auto_fill_mode is on.
+   * 'auto_fill_mode' is on.
    */
   mutable std::map<std::string, Column> columns;