]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update GridOutFlags::Svg documentation to show an example. 9474/head
authorgrahambenharper <grahambenharper@gmail.com>
Thu, 6 Feb 2020 21:59:47 +0000 (14:59 -0700)
committergrahambenharper <grahambenharper@gmail.com>
Fri, 7 Feb 2020 16:25:49 +0000 (09:25 -0700)
doc/doxygen/images/svg_flags.png [new file with mode: 0644]
include/deal.II/grid/grid_out.h

diff --git a/doc/doxygen/images/svg_flags.png b/doc/doxygen/images/svg_flags.png
new file mode 100644 (file)
index 0000000..f534467
Binary files /dev/null and b/doc/doxygen/images/svg_flags.png differ
index 0c4222582369b1a2545cfed090631377c34a3bd9..ab336a8c2a1351391054777389221a23f2d90575 100644 (file)
@@ -668,6 +668,13 @@ namespace GridOutFlags
   /**
    * Flags controlling SVG output.
    *
+   * The figure below is a zoomed-in illustration of what the SVG flags are
+   * capable of producing. These exact settings are the same as those used
+   * in the test <code>tests/grid/grid_out_svg_02.cc</code> with the addition
+   * of the flag <code>svg_flags.label_boundary_id = true;</code> .
+   *
+   * @image html svg_flags.png
+   *
    * @ingroup output
    */
   struct Svg

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.