]> https://gitweb.dealii.org/ - dealii.git/commitdiff
documentation fixes for hyper_L 6244/head
authorTimo Heister <timo.heister@gmail.com>
Fri, 13 Apr 2018 20:11:02 +0000 (16:11 -0400)
committerTimo Heister <timo.heister@gmail.com>
Fri, 13 Apr 2018 20:12:12 +0000 (16:12 -0400)
include/deal.II/grid/grid_generator.h

index df6f2ec0788a405dc5414b1ae110708650e398fa..064ff48464604d858f6b9cdb2dd892465f2c8f69 100644 (file)
@@ -642,10 +642,11 @@ namespace GridGenerator
    * test convergence of schemes when the solution lacks regularity.
    *
    * If the @p colorize flag is set, the @p boundary_ids of the
-   * surfaces are assigned, such that the left boundary is 0, and the
-   * others are set with growing number accordingly to the
-   * counterclockwise. Colorize option works only with 2-dimensional
-   * problem. This function will create the classical L-shape in 2d
+   * surfaces are assigned such that the left boundary is 0 and the
+   * others are assigned counterclockwise in ascending order.
+   * The @p colorize option only works in two dimensions.
+   *
+   * This function will create the classical L-shape in 2d
    * and it will look like the following in 3d:
    *
    * @image html hyper_l.png

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.