From: Timo Heister Date: Tue, 23 Jul 2019 16:09:19 +0000 (-0400) Subject: doc: correct friend markup in tensor X-Git-Tag: v9.2.0-rc1~1362^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F8408%2Fhead;p=dealii.git doc: correct friend markup in tensor Documentation is messed up by using doxygen markup for the comments for friend declarations as they replace the correct documentation (SymmetricTensor::trace for example). Fix this. --- diff --git a/include/deal.II/base/symmetric_tensor.h b/include/deal.II/base/symmetric_tensor.h index e8bd996113..2c4252560d 100644 --- a/include/deal.II/base/symmetric_tensor.h +++ b/include/deal.II/base/symmetric_tensor.h @@ -383,10 +383,8 @@ namespace internal tensor_type & tensor; const TableIndices previous_indices; - // declare some other classes - // as friends. make sure to - // work around bugs in some - // compilers + // Declare some other classes as friends. Make sure to work around bugs + // in some compilers: template friend class dealii::SymmetricTensor; template @@ -468,10 +466,8 @@ namespace internal tensor_type & tensor; const TableIndices previous_indices; - // declare some other classes - // as friends. make sure to - // work around bugs in some - // compilers + // Declare some other classes as friends. Make sure to work around bugs + // in some compilers: template friend class dealii::SymmetricTensor; template @@ -896,15 +892,11 @@ private: */ base_tensor_type data; - /** - * Make all other symmetric tensors friends. - */ + // Make all other symmetric tensors friends. template friend class SymmetricTensor; - /** - * Make a few more functions friends. - */ + // Make a few more functions friends. template friend DEAL_II_CONSTEXPR Number2 trace(const SymmetricTensor<2, dim2, Number2> &d); @@ -930,9 +922,7 @@ private: identity_tensor(); - /** - * Make a few helper classes friends as well. - */ + // Make a few helper classes friends as well. friend struct internal::SymmetricTensorImplementation:: Inverse<2, dim, Number>; diff --git a/include/deal.II/base/tensor.h b/include/deal.II/base/tensor.h index fb9526d226..75cccf88e6 100644 --- a/include/deal.II/base/tensor.h +++ b/include/deal.II/base/tensor.h @@ -362,9 +362,7 @@ private: unroll_recursion(Vector &result, unsigned int & start_index) const; - /** - * Allow an arbitrary Tensor to access the underlying values. - */ + // Allow an arbitrary Tensor to access the underlying values. template friend class Tensor; }; @@ -732,16 +730,12 @@ private: constexpr DEAL_II_CUDA_HOST_DEV Tensor(const ArrayLike &initializer, std_cxx14::index_sequence); - /** - * Allow an arbitrary Tensor to access the underlying values. - */ + // Allow an arbitrary Tensor to access the underlying values. template friend class Tensor; - /** - * Point is allowed access to the coordinates. This is supposed to improve - * speed. - */ + // Point is allowed access to the coordinates. This is supposed to improve + // speed. friend class Point; };