From: Krishnakumar Gopalakrishnan <krishna.kumar@ucl.ac.uk>
Date: Fri, 17 Jan 2020 15:09:06 +0000 (+0000)
Subject: fix documentation on add_table. Fixes 9355
X-Git-Tag: v9.3.0-rc1~1032^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=57c002abaeb3af753a092d14432eebc28968033c;p=dealii.git

fix documentation on add_table. Fixes 9355
---

diff --git a/include/deal.II/base/convergence_table.h b/include/deal.II/base/convergence_table.h
index 4e154c5892..9514442bd9 100644
--- a/include/deal.II/base/convergence_table.h
+++ b/include/deal.II/base/convergence_table.h
@@ -38,11 +38,12 @@ DEAL_II_NAMESPACE_OPEN
  * set in relation to the number of cells or the number of DoFs. The
  * implementations of these non-standard methods is left to a user.
  *
- * The number of cells and the number of DoFs may be added to the table by
- * calling e.g.  <tt>add_value("n cells", n_cells)</tt>. The table data is
- * also added by calling add_value().  Before the output of the table the
- * functions evaluate_convergence_rates() and evaluate_all_convergence_rates()
- * may be called.
+ * The number of cells may be added to the table by
+ * calling e.g.  `add_value("n cells", n_cells)`. The number of DoFs may be
+ * added to the table by calling `add_value("n dofs", n_dofs)`. Further table
+ * data is also added by calling add_value().  Before the output of the table
+ * the functions evaluate_convergence_rates() and
+ * evaluate_all_convergence_rates() may be called.
  *
  * There are two possibilities of how to evaluate the convergence rates of
  * multiple columns in the same RateMode.