Update comments for arrayDim and mirror

This commit is contained in:
Marek Roszko 2020-11-18 00:11:03 -05:00
parent 16e3e59495
commit f19440f72e
2 changed files with 5 additions and 5 deletions

View File

@ -24,7 +24,9 @@
#ifndef ARRAYDIM_H #ifndef ARRAYDIM_H
#define 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 <typename T, std::size_t N> template <typename T, std::size_t N>
constexpr std::size_t arrayDim( T const ( & )[N] ) noexcept constexpr std::size_t arrayDim( T const ( & )[N] ) noexcept
{ {

View File

@ -25,8 +25,7 @@
#define MIRROR_H #define MIRROR_H
/** /**
* Function MIRRORVAL * Returns the mirror of aPoint relative to the aMirrorRef.
* Mirror @a aPoint in @a aMirrorRef.
*/ */
template <typename T> template <typename T>
T MIRRORVAL( T aPoint, T aMirrorRef ) T MIRRORVAL( T aPoint, T aMirrorRef )
@ -35,8 +34,7 @@ T MIRRORVAL( T aPoint, T aMirrorRef )
} }
/** /**
* Function MIRROR * Updates aPoint with the mirror of aPoint relative to the aMirrorRef.
* Mirror @a aPoint in @a aMirrorRef.
*/ */
template <typename T> template <typename T>
void MIRROR( T& aPoint, const T& aMirrorRef ) void MIRROR( T& aPoint, const T& aMirrorRef )