From: grahambenharper <grahambenharper@gmail.com>
Date: Thu, 6 Feb 2020 21:59:47 +0000 (-0700)
Subject: Update GridOutFlags::Svg documentation to show an example.
X-Git-Tag: v9.2.0-rc1~536^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F9474%2Fhead;p=dealii.git

Update GridOutFlags::Svg documentation to show an example.
---

diff --git a/doc/doxygen/images/svg_flags.png b/doc/doxygen/images/svg_flags.png
new file mode 100644
index 0000000000..f5344671c6
Binary files /dev/null and b/doc/doxygen/images/svg_flags.png differ
diff --git a/include/deal.II/grid/grid_out.h b/include/deal.II/grid/grid_out.h
index 0c42225823..ab336a8c2a 100644
--- a/include/deal.II/grid/grid_out.h
+++ b/include/deal.II/grid/grid_out.h
@@ -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