From: Simon Sticko <simon@sticko.se>
Date: Tue, 17 Sep 2019 16:57:49 +0000 (+0200)
Subject: Remove doc stating FECollection is unused in hp::FE*Values classes.
X-Git-Tag: v9.2.0-rc1~1090^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a8a8922c05a6cb08cfb381567487c763dd71797b;p=dealii.git

Remove doc stating FECollection is unused in hp::FE*Values classes.

In the documentation of the constructors of the various hp::FE*Values
classes it is stated that the FECollection parameter passed to the
constructors isn't used inside the classed. This is no longer true.
Remove the statement.
---

diff --git a/include/deal.II/hp/fe_values.h b/include/deal.II/hp/fe_values.h
index 5591144050..2f08cc6f4b 100644
--- a/include/deal.II/hp/fe_values.h
+++ b/include/deal.II/hp/fe_values.h
@@ -241,12 +241,6 @@ namespace hp
 
     /**
      * Constructor. Initialize this object with the given parameters.
-     *
-     * The finite element collection parameter is actually ignored, but is in
-     * the signature of this function to make it compatible with the signature
-     * of the respective constructor of the usual FEValues object, with the
-     * respective parameter in that function also being the return value of
-     * the DoFHandler::get_fe() function.
      */
     FEValues(
       const dealii::hp::MappingCollection<dim, spacedim> &mapping_collection,
@@ -259,12 +253,6 @@ namespace hp
      * Constructor. This constructor is equivalent to the other one except
      * that it makes the object use a $Q_1$ mapping (i.e., an object of type
      * MappingQGeneric(1)) implicitly.
-     *
-     * The finite element collection parameter is actually ignored, but is in
-     * the signature of this function to make it compatible with the signature
-     * of the respective constructor of the usual FEValues object, with the
-     * respective parameter in that function also being the return value of
-     * the DoFHandler::get_fe() function.
      */
     FEValues(const hp::FECollection<dim, spacedim> &fe_collection,
              const hp::QCollection<dim> &           q_collection,
@@ -377,12 +365,6 @@ namespace hp
   public:
     /**
      * Constructor. Initialize this object with the given parameters.
-     *
-     * The finite element collection parameter is actually ignored, but is in
-     * the signature of this function to make it compatible with the signature
-     * of the respective constructor of the usual FEValues object, with the
-     * respective parameter in that function also being the return value of
-     * the <tt>DoFHandler::get_fe()</tt> function.
      */
     FEFaceValues(const hp::MappingCollection<dim, spacedim> &mapping_collection,
                  const hp::FECollection<dim, spacedim> &     fe_collection,
@@ -394,12 +376,6 @@ namespace hp
      * Constructor. This constructor is equivalent to the other one except
      * that it makes the object use a $Q_1$ mapping (i.e., an object of type
      * MappingQGeneric(1)) implicitly.
-     *
-     * The finite element collection parameter is actually ignored, but is in
-     * the signature of this function to make it compatible with the signature
-     * of the respective constructor of the usual FEValues object, with the
-     * respective parameter in that function also being the return value of
-     * the <tt>DoFHandler::get_fe()</tt> function.
      */
     FEFaceValues(const hp::FECollection<dim, spacedim> &fe_collection,
                  const hp::QCollection<dim - 1> &       q_collection,
@@ -497,12 +473,6 @@ namespace hp
   public:
     /**
      * Constructor. Initialize this object with the given parameters.
-     *
-     * The finite element collection parameter is actually ignored, but is in
-     * the signature of this function to make it compatible with the signature
-     * of the respective constructor of the usual FEValues object, with the
-     * respective parameter in that function also being the return value of
-     * the <tt>DoFHandler::get_fe()</tt> function.
      */
     FESubfaceValues(
       const hp::MappingCollection<dim, spacedim> &mapping_collection,
@@ -515,12 +485,6 @@ namespace hp
      * Constructor. This constructor is equivalent to the other one except
      * that it makes the object use a $Q_1$ mapping (i.e., an object of type
      * MappingQGeneric(1)) implicitly.
-     *
-     * The finite element collection parameter is actually ignored, but is in
-     * the signature of this function to make it compatible with the signature
-     * of the respective constructor of the usual FEValues object, with the
-     * respective parameter in that function also being the return value of
-     * the <tt>DoFHandler::get_fe()</tt> function.
      */
     FESubfaceValues(const hp::FECollection<dim, spacedim> &fe_collection,
                     const hp::QCollection<dim - 1> &       q_collection,