]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix a doxygen table. 9869/head
authorDavid Wells <drwells@email.unc.edu>
Fri, 10 Apr 2020 13:51:12 +0000 (09:51 -0400)
committerDavid Wells <drwells@email.unc.edu>
Fri, 10 Apr 2020 13:51:12 +0000 (09:51 -0400)
Doxygen has its own syntax for tables.

include/deal.II/base/bounding_box.h

index 6af0ec964faa09d39217f2489f7e8d07fccd21aa..2d3002411a017eae5cd15fcefb0f3c5ffcc6871c 100644 (file)
@@ -288,26 +288,21 @@ namespace internal
    * value.
    *
    * The convention is the following: Starting from the locked coordinate we
-   * store the lower dimensional coordinates consecutively and wrapping
-   * around when going over the dimension. This relationship can be
-   * described by the following tables:
+   * store the lower dimensional coordinates consecutively and wrap around
+   * when going over the dimension. This relationship is, in 2D,
    *
-   *                        2D
-   * ------------------------------------------------
    * | locked in 2D | 1D coordinate | 2D coordinate |
-   * |--------------------------------------------- |
+   * |:------------:|:-------------:|:-------------:|
    * |     x0       |      (a)      |   (x0,  a)    |
    * |     x1       |      (a)      |   (a , x1)    |
-   * ------------------------------------------------
    *
-   *                       3D
-   * --------------------------------------------------
+   * and, in 3D,
+   *
    * | locked in 3D | 2D coordinates | 3D coordinates |
-   * |----------------------------------------------- |
+   * |:-------------|:--------------:|:--------------:|
    * |     x0       |    (a, b)      | (x0,  a,  b)   |
    * |     x1       |    (a, b)      | ( b, x1,  a)   |
    * |     x2       |    (a, b)      | ( a,  b, x2)   |
-   * --------------------------------------------------
    *
    * Given a locked coordinate, this function maps a coordinate index in dim
    * dimension to a coordinate index in dim + 1 dimensions.

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.