From 5938e2ba6113d3ac7c7456512cc2a19c643b3d5d Mon Sep 17 00:00:00 2001
From: Christos Choutouridis <cchoutou@ece.auth.gr>
Date: Sun, 3 May 2020 15:00:17 +0100
Subject: [PATCH] FIX: comment rework

---
 main.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/main.c b/main.c
index 8112711..2acf522 100644
--- a/main.c
+++ b/main.c
@@ -54,9 +54,11 @@ len_loop                    // do {
  *      We use a simple O(n), no stack algorithm.
  * @note
  *      This function also writes to RAM address @ref RESULT the return value (which is nasty).
- * @arg     R0: Pointer to string
- * @return  R0: True if predicate
- *              False if not
+ * @arg     src{R0}     Pointer to string
+ * @return  {R0}        True if palindrome, false if not or src is NULL pointer
+ * @note
+ *      We consider an empty string "" to be a palindrome, as we can see it the same way both
+ *      from the front and the back.
  */
 __asm uint32_t isPalindrome (const char* src) {
     // R0: src[]