From: Wolfgang Bangerth <bangerth@math.tamu.edu>
Date: Thu, 20 Aug 2015 23:26:16 +0000 (-0500)
Subject: Link to the new documentation module.
X-Git-Tag: v8.4.0-rc2~561^2~3
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f5bcdaae1b6ddbbd333ab4156fa90f5dbf5d0c74;p=dealii.git

Link to the new documentation module.
---

diff --git a/include/deal.II/fe/fe.h b/include/deal.II/fe/fe.h
index 1a4ee78c98..e03f840ff3 100644
--- a/include/deal.II/fe/fe.h
+++ b/include/deal.II/fe/fe.h
@@ -2213,6 +2213,10 @@ protected:
    * cell. Returns a pointer to an object of which the caller of this function
    * then has to assume ownership (which includes destruction when it is no
    * more needed).
+   *
+   * An extensive discussion of the interaction between this function and
+   * FEValues can be found in the @ref FE_vs_Mapping_vs_FEValues documentation
+   * module.
    */
   virtual InternalDataBase *
   get_data (const UpdateFlags      flags,
@@ -2241,6 +2245,13 @@ protected:
                     const Mapping<dim,spacedim>      &mapping,
                     const Quadrature<dim-1> &quadrature) const;
 
+  /**
+   * To be written.
+   *
+   * An extensive discussion of the interaction between this function and
+   * FEValues can be found in the @ref FE_vs_Mapping_vs_FEValues documentation
+   * module.
+   */
   virtual
   void
   fill_fe_values (const Mapping<dim,spacedim>                                         &mapping,
diff --git a/include/deal.II/fe/mapping.h b/include/deal.II/fe/mapping.h
index 4611076daf..56c104bd2f 100644
--- a/include/deal.II/fe/mapping.h
+++ b/include/deal.II/fe/mapping.h
@@ -547,6 +547,10 @@ protected:
    * instead, from which the determinant can also be computed -- but
    * this does not take away from the instructiveness of the example.)
    *
+   * An extensive discussion of the interaction between this function and
+   * FEValues can be found in the @ref FE_vs_Mapping_vs_FEValues documentation
+   * module.
+   *
    * @see UpdateFlags
    */
   virtual
@@ -575,6 +579,10 @@ protected:
    * The mapping classes do not keep track of the objects created by
    * this function. Ownership will therefore rest with the caller.
    *
+   * An extensive discussion of the interaction between this function and
+   * FEValues can be found in the @ref FE_vs_Mapping_vs_FEValues documentation
+   * module.
+   *
    * @param update_flags A set of flags that define what is expected of
    *   the mapping class in future calls to transform() or the
    *   fill_fe_values() group of functions. This set of flags may
@@ -708,6 +716,10 @@ protected:
    * by the update flags stored in the Mapping::InternalDataBase object
    * passed to this function.
    *
+   * An extensive discussion of the interaction between this function and
+   * FEValues can be found in the @ref FE_vs_Mapping_vs_FEValues documentation
+   * module.
+   *
    * @param[in] cell The cell of the triangulation for which this function
    *   is to compute a mapping from the reference cell to.
    * @param[in] cell_similarity Whether or not the cell given as first
@@ -752,6 +764,13 @@ protected:
    *   cell similarity is too optimistic, and invalidate it for
    *   subsequent use in FiniteElement::fill_fe_values() by
    *   returning a less optimistic cell similarity value.
+   *
+   * @note FEValues ensures that this function is always called with
+   *   the same pair of @p internal_data and @output_data objects. In
+   *   other words, if an implementation of this function knows that it
+   *   has written a piece of data into the output argument in a previous
+   *   call, then there is no need to copy it there again in a later
+   *   call if the implementation knows that this is the same value.
    */
   virtual
   CellSimilarity::Similarity