]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Minor documentation changes for TableHandler 9765/head
authorReza Rastak <rastak@stanford.edu>
Sun, 29 Mar 2020 05:13:50 +0000 (22:13 -0700)
committerReza Rastak <rastak@stanford.edu>
Sun, 29 Mar 2020 05:13:50 +0000 (22:13 -0700)
include/deal.II/base/table_handler.h

index 63a3f5b014b3a31d71e67c6554d7a4446deb0470..aef7443dc17e376ae7fc0d56b49651f803997a4b 100644 (file)
@@ -182,8 +182,8 @@ namespace internal
  * <h3>Example</h3>
  *
  * This is a simple example demonstrating the usage of this class. The first
- * column includes the numbers <tt>i=1..n</tt>, the second $1^2$...$n^2$, the
- * third $sqrt(1)...sqrt(n)$, where the second and third columns are merged
+ * column includes the numbers $i=1 \dots n$, the second $1^2 \dots n^2$, the
+ * third $\sqrt{1}\dots\sqrt{n}$, where the second and third columns are merged
  * into one supercolumn with the superkey <tt>squares and roots</tt>.
  * Additionally the first column is aligned to the right (the default was
  * <tt>centered</tt>) and the precision of the square roots are set to be 6
@@ -191,22 +191,21 @@ namespace internal
  *
  * @code
  * TableHandler table;
- *
- * for (unsigned int i=1; i<=n; ++i)
+ * for (unsigned int i = 1; i <= n; ++i)
  *   {
  *     table.add_value("numbers", i);
- *     table.add_value("squares", i*i);
- *     table.add_value("square roots", std::sqrt(1.*i));
+ *     table.add_value("squares", i * i);
+ *     table.add_value("square roots", std::sqrt(i));
  *   }
- *                                  // merge the second and third column
+ * // merge the second and third column
  * table.add_column_to_supercolumn("squares", "squares and roots");
  * table.add_column_to_supercolumn("square roots", "squares and roots");
  *
- *                                  // additional settings
+ * // additional settings
  * table.set_tex_format("numbers", "r");
  * table.set_precision("square roots", 6);
  *
- *                                  // output
+ * // output
  * std::ofstream out_file("number_table.tex");
  * table.write_tex(out_file);
  * out_file.close();

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.