diff --git a/include/core/arraydim.h b/include/core/arraydim.h index 5d7f4c7e70..50ac7c9dce 100644 --- a/include/core/arraydim.h +++ b/include/core/arraydim.h @@ -24,7 +24,9 @@ #ifndef ARRAYDIM_H #define ARRAYDIM_H -/// # of elements in an array. This implements type-safe compile time checking +/** + * Returns # of elements in an array. This implements type-safe compile time checking + */ template constexpr std::size_t arrayDim( T const ( & )[N] ) noexcept { diff --git a/include/core/mirror.h b/include/core/mirror.h index b463bf15f6..ee0fbe69b5 100644 --- a/include/core/mirror.h +++ b/include/core/mirror.h @@ -25,8 +25,7 @@ #define MIRROR_H /** - * Function MIRRORVAL - * Mirror @a aPoint in @a aMirrorRef. + * Returns the mirror of aPoint relative to the aMirrorRef. */ template T MIRRORVAL( T aPoint, T aMirrorRef ) @@ -35,8 +34,7 @@ T MIRRORVAL( T aPoint, T aMirrorRef ) } /** - * Function MIRROR - * Mirror @a aPoint in @a aMirrorRef. + * Updates aPoint with the mirror of aPoint relative to the aMirrorRef. */ template void MIRROR( T& aPoint, const T& aMirrorRef )