From 887051ca57ab3e20154ea3ef33ac881900780839 Mon Sep 17 00:00:00 2001 From: Matthias Maier Date: Tue, 15 Sep 2015 21:23:32 -0500 Subject: [PATCH] Documentation: Fix doxygen markup in tensor_deprecated.h --- include/deal.II/base/tensor_accessors.h | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/include/deal.II/base/tensor_accessors.h b/include/deal.II/base/tensor_accessors.h index 8cdbf603a7..3251ec6877 100644 --- a/include/deal.II/base/tensor_accessors.h +++ b/include/deal.II/base/tensor_accessors.h @@ -65,6 +65,8 @@ DEAL_II_NAMESPACE_OPEN * of such objects. * * @ingroup geomprimitives + * + * @author Matthias Maier, 2015 */ namespace TensorAccessors { @@ -172,21 +174,13 @@ namespace TensorAccessors * * @tparam index The index to be shifted to the end. Indices are counted * from 0, thus the valid range is $0\le\text{index}<\text{rank}$. - * @tparam rank Rank of the tensorial object @param t + * @tparam rank Rank of the tensorial object @p t * @tparam T A tensorial object of rank @p rank. @p T must * provide a local typedef value_type and an index operator * operator[]() that returns a (const or non-const) - * reference of value_type: - * @code - * class T - * { - * typedef ... value_type - * value_type & operator[](unsigned int); - * const value_type & operator[](unsigned int) const; - * }; - * @endcode + * reference of value_type. * - * @relates ReorderedIndexView + * @author Matthias Maier, 2015 */ template internal::ReorderedIndexView @@ -215,11 +209,13 @@ namespace TensorAccessors * local typedef value_type and an index operator * operator[]() that returns a (const or non-const) * reference of value_type. Further, its tensorial rank must - * be equal or greater than @p rank + * be equal or greater than @p rank. * * @tparam ArrayType An array like object, such as std::array, or * dealii::TableIndices that stores at least @p rank indices that can be * accessed via operator[](). + * + * @author Matthias Maier, 2015 */ template typename ReturnType::value_type & @@ -264,6 +260,8 @@ namespace TensorAccessors * @note The Types @p T1, @p T2, and @p T3 must have rank * rank_1 + rank_2 - 2 * no_contr, rank_1, or rank_2, respectively. * Obviously, no_contr must be less or equal than rank_1 and rank_2. + * + * @author Matthias Maier, 2015 */ template void contract(T1 &result, const T2 &left, const T3 &right) @@ -308,6 +306,8 @@ namespace TensorAccessors * @note The Types @p T2, @p T3, and @p T4 must have * rank rank_1, rank_1 + rank_2, and rank_3, respectively. @p T1 * must be a scalar type. + * + * @author Matthias Maier, 2015 */ template T1 contract3(const T2 &left, const T3 &middle, const T4 &right) -- 2.39.5