From: Wolfgang Bangerth <bangerth@math.tamu.edu>
Date: Thu, 14 Apr 2016 21:07:17 +0000 (-0500)
Subject: Update a copy-paste error for DoFTools::extract_boundary_dofs().
X-Git-Tag: v8.5.0-rc1~1105^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=722220228613a7616b6a8c657a372ff8a4172862;p=dealii.git

Update a copy-paste error for DoFTools::extract_boundary_dofs().

There are two functions of the same name with the same documentation, but in one
the argument is a std::vector<bool> and in the other it is an IndexSet. The former's
documentation was copied from the latter's and referred to the wrong data type.

While there, also mark arguments as [in] or [out].
---

diff --git a/include/deal.II/dofs/dof_tools.h b/include/deal.II/dofs/dof_tools.h
index e36be1c736..cad1d5e9cf 100644
--- a/include/deal.II/dofs/dof_tools.h
+++ b/include/deal.II/dofs/dof_tools.h
@@ -1293,17 +1293,18 @@ namespace DoFTools
    * parallel triangulations, then you need to use the other
    * DoFTools::extract_boundary_dofs function.
    *
-   * @param dof_handler The object that describes which degrees of freedom
+   * @param[in] dof_handler The object that describes which degrees of freedom
    * live on which cell
-   * @param component_mask A mask denoting the vector components of the finite
+   * @param[in] component_mask A mask denoting the vector components of the finite
    * element that should be considered (see also
    * @ref GlossComponentMask).
-   * @param selected_dofs The IndexSet object that is returned and that will
-   * contain the indices of degrees of freedom that are located on the
+   * @param[out] selected_dofs A vector of booleans that is returned and for which
+   * an element will be @p true if the corresponding index is a
+   * degree of freedom that is located on the
    * boundary (and correspond to the selected vector components and boundary
    * indicators, depending on the values of the @p component_mask and @p
    * boundary_ids arguments).
-   * @param boundary_ids If empty, this function extracts the indices of the
+   * @param[in] boundary_ids If empty, this function extracts the indices of the
    * degrees of freedom for all parts of the boundary. If it is a non- empty
    * list, then the function only considers boundary faces with the boundary
    * indicators listed in this argument.
@@ -1330,17 +1331,17 @@ namespace DoFTools
    * the locally relevant set (see
    * @ref GlossLocallyRelevantDof "locally relevant DoFs").
    *
-   * @param dof_handler The object that describes which degrees of freedom
+   * @param[in] dof_handler The object that describes which degrees of freedom
    * live on which cell
-   * @param component_mask A mask denoting the vector components of the finite
+   * @param[in] component_mask A mask denoting the vector components of the finite
    * element that should be considered (see also
    * @ref GlossComponentMask).
-   * @param selected_dofs The IndexSet object that is returned and that will
+   * @param[out] selected_dofs The IndexSet object that is returned and that will
    * contain the indices of degrees of freedom that are located on the
    * boundary (and correspond to the selected vector components and boundary
    * indicators, depending on the values of the @p component_mask and @p
    * boundary_ids arguments).
-   * @param boundary_ids If empty, this function extracts the indices of the
+   * @param[in] boundary_ids If empty, this function extracts the indices of the
    * degrees of freedom for all parts of the boundary. If it is a non- empty
    * list, then the function only considers boundary faces with the boundary
    * indicators listed in this argument.