From: David Wells Date: Thu, 8 Oct 2015 19:30:25 +0000 (-0400) Subject: Fix some erroneous uses of @tparam. X-Git-Tag: v8.4.0-rc2~330^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F1731%2Fhead;p=dealii.git Fix some erroneous uses of @tparam. @tparam, unlike @param, starts a new paragraph where it is used. This causes some strangely formatted documentation. --- diff --git a/include/deal.II/base/polynomial_space.h b/include/deal.II/base/polynomial_space.h index 9c73f2d1f4..8853bf40d8 100644 --- a/include/deal.II/base/polynomial_space.h +++ b/include/deal.II/base/polynomial_space.h @@ -154,10 +154,12 @@ public: const Point &p) const; /** - * Computes the order @tparam order derivative of the ith - * polynomial at unit point p. + * Computes the orderth derivative of the ith polynomial + * at unit point p. * * Consider using compute() instead. + * + * @tparam order The order of the derivative. */ template Tensor compute_derivative (const unsigned int i, diff --git a/include/deal.II/base/table_indices.h b/include/deal.II/base/table_indices.h index 62dabf1de9..573b380faf 100644 --- a/include/deal.II/base/table_indices.h +++ b/include/deal.II/base/table_indices.h @@ -52,11 +52,13 @@ public: * to populate a TableIndices object upon creation, either completely, or * partially. * - * Index entries that are not set by this 1 - 9 arguments (either - * because they are omitted, or because @tparam N is larger than 9) are - * set to numbers::invalid_unsigned_int. + * Index entries that are not set by these arguments (either because + * they are omitted, or because $N > 9$) are set to + * numbers::invalid_unsigned_int. * - * Note that only the first @tparam N arguments are actually used. + * Note that only the first N arguments are actually used. + * + * @tparam N The number of indices stored in each object. */ TableIndices (const unsigned int index0, const unsigned int index1 = numbers::invalid_unsigned_int, diff --git a/include/deal.II/base/tensor.h b/include/deal.II/base/tensor.h index b59c1f1c95..e0a3b0ce13 100644 --- a/include/deal.II/base/tensor.h +++ b/include/deal.II/base/tensor.h @@ -1394,7 +1394,9 @@ operator / (const Tensor &t, /** - * Addition of two tensors of general @tparam rank. + * Addition of two tensors of general rank. + * + * @tparam rank The rank of both tensors. * * @relates Tensor */ @@ -1413,7 +1415,9 @@ operator+ (const Tensor &p, const Tensor /** - * Subtraction of two tensors of general @tparam rank. + * Subtraction of two tensors of general rank. + * + * @tparam rank The rank of both tensors. * * @relates Tensor */ diff --git a/include/deal.II/base/tensor_product_polynomials.h b/include/deal.II/base/tensor_product_polynomials.h index 6cc9c3bedc..8f71e53ae1 100644 --- a/include/deal.II/base/tensor_product_polynomials.h +++ b/include/deal.II/base/tensor_product_polynomials.h @@ -135,7 +135,7 @@ public: const Point &p) const; /** - * Computes the order @tparam order derivative of the ith tensor + * Computes the orderth derivative of the ith tensor * product polynomial at unit_point. Here i is given in * tensor product numbering. * @@ -145,6 +145,8 @@ public: * several times. Instead use the compute() function, see above, with * the size of the appropriate parameter set to n() to get the point value * of all tensor polynomials all at once and in a much more efficient way. + * + * @tparam order The derivative order. */ template Tensor compute_derivative (const unsigned int i, @@ -288,7 +290,7 @@ public: const Point &p) const; /** - * Computes the order @tparam order derivative of the ith tensor + * Computes the orderth derivative of the ith tensor * product polynomial at unit_point. Here i is given in * tensor product numbering. * @@ -298,6 +300,8 @@ public: * several times. Instead use the compute() function, see above, with * the size of the appropriate parameter set to n() to get the point value * of all tensor polynomials all at once and in a much more efficient way. + * + * @tparam order The derivative order. */ template Tensor compute_derivative (const unsigned int i, diff --git a/include/deal.II/base/tensor_product_polynomials_const.h b/include/deal.II/base/tensor_product_polynomials_const.h index 9bfa94bc72..d0441b05b2 100644 --- a/include/deal.II/base/tensor_product_polynomials_const.h +++ b/include/deal.II/base/tensor_product_polynomials_const.h @@ -96,7 +96,7 @@ public: const Point &p) const; /** - * Computes the order @tparam order derivative of the ith tensor + * Computes the orderth derivative of the ith tensor * product polynomial at unit_point. Here i is given in * tensor product numbering. * @@ -106,6 +106,8 @@ public: * several times. Instead use the compute() function, see above, with * the size of the appropriate parameter set to n() to get the point value * of all tensor polynomials all at once and in a much more efficient way. + * + * @tparam order The derivative order. */ template Tensor compute_derivative (const unsigned int i,