From: Wolfgang Bangerth <bangerth@colostate.edu>
Date: Thu, 28 Apr 2022 21:33:26 +0000 (-0600)
Subject: Update documentation in DataOutFaces.
X-Git-Tag: v9.4.0-rc1~297^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F13655%2Fhead;p=dealii.git

Update documentation in DataOutFaces.
---

diff --git a/include/deal.II/numerics/data_out_faces.h b/include/deal.II/numerics/data_out_faces.h
index 840e3269eb..fb9a4f8a51 100644
--- a/include/deal.II/numerics/data_out_faces.h
+++ b/include/deal.II/numerics/data_out_faces.h
@@ -126,8 +126,15 @@ public:
       cell_iterator;
 
   /**
-   * Constructor determining whether a surface mesh (default) or the whole
-   * wire basket is written.
+   * Constructor.
+   *
+   * @param[in] surface_only If `true`, then this class only generates
+   *   output on faces that lie on the boundary of the domain. This
+   *   is typically what this class is used for: To output information
+   *   about the solution, fluxes, and other quantities that live on
+   *   the boundary of the domain. On the other hand, it is sometimes
+   *   useful to also visualize data on internal faces. This is
+   *   facilitated by setting this argument to `false`.
    */
   DataOutFaces(const bool surface_only = true);