From f19440f72ea01508fd1b6f45e5c7c6f94edf4e91 Mon Sep 17 00:00:00 2001
From: Marek Roszko <mark.roszko@gmail.com>
Date: Wed, 18 Nov 2020 00:11:03 -0500
Subject: [PATCH] Update comments for arrayDim and mirror

---
 include/core/arraydim.h | 4 +++-
 include/core/mirror.h   | 6 ++----
 2 files changed, 5 insertions(+), 5 deletions(-)

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 <typename T, std::size_t N>
 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 <typename T>
 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 <typename T>
 void MIRROR( T& aPoint, const T& aMirrorRef )