Remove a few TODOs by adding docs.

git-svn-id: https://svn.dealii.org/trunk@9510 0785d39b-7218-0410-832d-ea1e28bc413d

diff --git a/deal.II/deal.II/include/fe/fe_values.h b/deal.II/deal.II/include/fe/fe_values.h
index c507ffe7a4f71c41c9feacb1b0b3f71b069ca732..517cddb842145e74699244e4219a01278d6401f8 100644 (file)
--- a/deal.II/deal.II/include/fe/fe_values.h
+++ b/deal.II/deal.II/include/fe/fe_values.h
@@ -1606,8 +1606,26 @@ class FEValues : public FEValuesBase<dim>
                                      /**
                                       * Return a reference to this
                                       * very object.
+                                      *
+                                      * Though it seems that it is not very
+                                      * useful, this function is there to
+                                      * provide capability to the hpFEValues
+                                      * class, in which case it provides the
+                                      * FEValues object for the present cell
+                                      * (remember that for hp finite elements,
+                                      * the actual FE object used may change
+                                      * from cell to cell, so we also need
+                                      * different FEValues objects for
+                                      * different cells; once you reinitialize
+                                      * the hpFEValues object for a specific
+                                      * cell, it retrieves the FEValues object
+                                      * for the FE on that cell and returns it
+                                      * through a function of the same name as
+                                      * this one; this function here therefore
+                                      * only provides the same interface so
+                                      * that one can templatize on
+                                      * FEValues/hpFEValues).
                                       */
-//TODO: explain reason    
     const FEValues<dim> & get_present_fe_values () const;
     
   private:
@@ -1838,8 +1856,26 @@ class FEFaceValues : public FEFaceValuesBase<dim>
                                      /**
                                       * Return a reference to this
                                       * very object.
+                                      *
+                                      * Though it seems that it is not very
+                                      * useful, this function is there to
+                                      * provide capability to the hpFEValues
+                                      * class, in which case it provides the
+                                      * FEValues object for the present cell
+                                      * (remember that for hp finite elements,
+                                      * the actual FE object used may change
+                                      * from cell to cell, so we also need
+                                      * different FEValues objects for
+                                      * different cells; once you reinitialize
+                                      * the hpFEValues object for a specific
+                                      * cell, it retrieves the FEValues object
+                                      * for the FE on that cell and returns it
+                                      * through a function of the same name as
+                                      * this one; this function here therefore
+                                      * only provides the same interface so
+                                      * that one can templatize on
+                                      * FEValues/hpFEValues).
                                       */
-//TODO: explain reason    
     const FEFaceValues<dim> & get_present_fe_values () const;
   private:
 
@@ -1973,8 +2009,26 @@ class FESubfaceValues : public FEFaceValuesBase<dim>
                                      /**
                                       * Return a reference to this
                                       * very object.
+                                      *
+                                      * Though it seems that it is not very
+                                      * useful, this function is there to
+                                      * provide capability to the hpFEValues
+                                      * class, in which case it provides the
+                                      * FEValues object for the present cell
+                                      * (remember that for hp finite elements,
+                                      * the actual FE object used may change
+                                      * from cell to cell, so we also need
+                                      * different FEValues objects for
+                                      * different cells; once you reinitialize
+                                      * the hpFEValues object for a specific
+                                      * cell, it retrieves the FEValues object
+                                      * for the FE on that cell and returns it
+                                      * through a function of the same name as
+                                      * this one; this function here therefore
+                                      * only provides the same interface so
+                                      * that one can templatize on
+                                      * FEValues/hpFEValues).
                                       */
-//TODO: explain reason    
     const FESubfaceValues<dim> & get_present_fe_values () const;
 
                                      /**