From 4a5a88a3a37a3ea04cdf138992815334cafd465c Mon Sep 17 00:00:00 2001 From: Matthias Maier Date: Fri, 25 Sep 2015 20:47:07 -0500 Subject: [PATCH] tensor_deprecated.h: Bugfix: Let doxygen pick up function references --- include/deal.II/base/tensor.h | 4 ++-- include/deal.II/base/tensor_deprecated.h | 20 ++++++++++---------- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/include/deal.II/base/tensor.h b/include/deal.II/base/tensor.h index 4fbac9328c..b59c1f1c95 100644 --- a/include/deal.II/base/tensor.h +++ b/include/deal.II/base/tensor.h @@ -1707,7 +1707,7 @@ outer_product(const Tensor &src1, /** - * Returns the cross-product in 2d. This is just a rotation by 90 degrees + * Returns the cross product in 2d. This is just a rotation by 90 degrees * clockwise to compute the outer normal from a tangential vector. This * function is defined for all space dimensions to allow for dimension * independent programming (e.g. within switches over the space dimension), @@ -1734,7 +1734,7 @@ cross_product_2d (const Tensor<1,dim,Number> &src) /** - * Returns the cross-product of 2 vectors in 3d. This function is defined + * Returns the cross product of 2 vectors in 3d. This function is defined * for all space dimensions to allow for dimension independent programming * (e.g. within switches over the space dimension), but may only be called * if the actual dimension of the arguments is three (e.g. from the diff --git a/include/deal.II/base/tensor_deprecated.h b/include/deal.II/base/tensor_deprecated.h index 07bbad08b5..e936e0534e 100644 --- a/include/deal.II/base/tensor_deprecated.h +++ b/include/deal.II/base/tensor_deprecated.h @@ -44,8 +44,8 @@ DeclException1 (ExcInvalidTensorContractionIndex, * Double contract two tensors of rank 2, thus computing the Frobenius inner * product sumi,j src1[i][j]*src2[i][j]. * - * @deprecated Use the double_contract function that takes indices as template - * arguments and returns its result instead. + * @deprecated Use the double_contract() function that takes indices as + * template arguments and returns its result instead. * @relates Tensor */ template @@ -59,7 +59,7 @@ Number double_contract (const Tensor<2, dim, Number> &src1, * src2, creating a rank-2 tensor. This is the matrix-vector product * analog operation between tensors of rank 4 and rank 2. * - * @deprecated Use the double_contract function that takes indices as + * @deprecated Use the double_contract() function that takes indices as * template arguments and returns its result instead. * @relates Tensor */ @@ -75,7 +75,7 @@ void double_contract (Tensor<2,dim,Number> &dest, * index2 of the second tensor. Note that the number of the index * is counted from 1 on, not from zero as usual. * - * @deprecated Use the contract function that takes indices as template + * @deprecated Use the contract() function that takes indices as template * arguments and returns its result instead. * @relates Tensor */ @@ -92,7 +92,7 @@ void contract (Tensor<2,dim,Number> &dest, * performed over index index1 of the first tensor. Note that the * number of the index is counted from 1 on, not from zero as usual. * - * @deprecated Use the contract function that takes indices as template + * @deprecated Use the contract() function that takes indices as template * arguments and returns its result instead. * @relates Tensor */ @@ -109,7 +109,7 @@ void contract (Tensor<2,dim,Number> &dest, * index2 of the second tensor. Note that the number of the index * is counted from 1 on, not from zero as usual. * - * @deprecated Use the contract function that takes indices as template + * @deprecated Use the contract() function that takes indices as template * arguments and returns its result instead. * @relates Tensor */ @@ -150,10 +150,10 @@ contract (const Tensor<1,dim,Number> &src1, /** - * The cross-product of one vector in 2d. This is just a rotation by 90 + * The cross product of one vector in 2d. This is just a rotation by 90 * degrees. * - * @deprecated Use the function cross_product_2d that returns the value. + * @deprecated Use the function cross_product_2d() that returns the value. * @relates Tensor */ template @@ -163,9 +163,9 @@ cross_product (Tensor<1,dim,Number> &dst, const Tensor<1,dim,Number> &src) DEAL_II_DEPRECATED; /** - * The cross-product of 2 vectors in 3d. + * The cross product of 2 vectors in 3d. * - * @deprecated Use the function cross_product_3d that returns the value. + * @deprecated Use the function cross_product_3d() that returns the value. * @relates Tensor */ template -- 2.39.5