From f7ffd1a331a146579dc7a78ce21216a104c723b4 Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Tue, 27 Nov 2018 12:18:34 -0500 Subject: [PATCH] docs: TableHandler fixes --- include/deal.II/base/table_handler.h | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) 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 auto-fill mode. 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 add_value(key, - * value), we count the number of elements in the column corresponding - * to key. 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 T() to this - * column. Here, T is the data type of the given + * use the following algorithm: + * + * - When calling add_value(key, value), we count the number of + * elements in the column corresponding to key. 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 T() to + * this column. Here, T is the data type of the given * value. For example, if T is a numeric type, then * T() is the number zero; if T is * std::string, then T() is the empty string - * "". - Add the given value to this column. + * "". + * + * - 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 "". * * 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 columns; -- 2.39.5