Include doc for power function.

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

diff --git a/deal.II/base/include/base/tensor_product_polynomials.h b/deal.II/base/include/base/tensor_product_polynomials.h
index 69b7fdf3773146c26469f46a910f49d1fed03a02..dcdace986e2bf8ad2f098c7a6a20b67fe612aca5 100644 (file)
--- a/deal.II/base/include/base/tensor_product_polynomials.h
+++ b/deal.II/base/include/base/tensor_product_polynomials.h
@@ -195,7 +195,13 @@ class TensorProductPolynomials
                                      */
     std::vector<unsigned int> n_pols_to;
     
-    
+                                    /**
+                                     * Computes @p{x} to the power of
+                                     * @p{y} for unsigned int @p{x}
+                                     * and @p{y}. It is a private
+                                     * function as it is only used in
+                                     * this class.
+                                     */
     static unsigned int power(const unsigned int x, const unsigned int y);
 };
 

diff --git a/deal.II/base/source/tensor_product_polynomials.cc b/deal.II/base/source/tensor_product_polynomials.cc
index 6866f71d0810b574c9c6d91218f700d2520335d5..a1759afc37338a04100601be9be28e0ea709d155 100644 (file)
--- a/deal.II/base/source/tensor_product_polynomials.cc
+++ b/deal.II/base/source/tensor_product_polynomials.cc
@@ -17,11 +17,6 @@
 
 
 
-//TODO: [RH] Is this function only used inside this class?
-// It should be inline, anyway. Also, there is no documentation.
-// rather, make it a file-static function, or better in an anonymous
-// namespace
-
 template <int dim>
 unsigned int TensorProductPolynomials<dim>::power(const unsigned int x,
                                                  const unsigned int y)