fix: solve recorder_debug members not documented doxygen warning (#112)

Add @cond to helper functions in recorder_debug.cpp to prevent flagging
in doxygen

Add documentation to Recorder_debug_menu

src/debug/recorder_debug.cpp

@@ -21,15 +21,51 @@
 #include <stdint.h>
 #include <stdio.h>
 
-void REC_testHasData(void);
-void REC_testNumFiles(void);
-void REC_testGetLastPacket(void);
-void REC_testOpen(void);
-void REC_testClose(void);
-void REC_testPutBytes(void);
-void REC_testSetTime(void);
-void REC_testCreateBigSession(void);
-void REC_testPopLastPacket(void);
+/**
+ * @brief Function to test if recorder has data
+ *
+ */
+static void REC_testHasData(void);
+/**
+ * @brief Function to test if we can retrieve number of files in filesystem
+ *
+ */
+static void REC_testNumFiles(void);
+/**
+ * @brief Function to test if we can retrieve last packet in memory
+ *
+ */
+static void REC_testGetLastPacket(void);
+/**
+ * @brief Function to test if we can open a recording session
+ *
+ */
+static void REC_testOpen(void);
+/**
+ * @brief Function to test if we can close a recording session
+ *
+ */
+static void REC_testClose(void);
+/**
+ * @brief Function to test if we can input bytes into data buffer
+ *
+ */
+static void REC_testPutBytes(void);
+/**
+ * @brief Function to test if we can set start time of recording session
+ *
+ */
+static void REC_testSetTime(void);
+/**
+ * @brief Function to test if we can create session & store in session of byte size inputted by user
+ *
+ */
+static void REC_testCreateBigSession(void);
+/**
+ * @brief Function to test if we can pop the last packet in memory
+ *
+ */
+static void REC_testPopLastPacket(void);
 
 const Menu_t Recorder_debug_menu[] =
 {
@@ -185,4 +221,4 @@ void REC_testPopLastPacket(void)
     retval = pRecorder->popLastPacket(SF_PACKET_SIZE);
 
     SF_OSAL_printf("Returned %d" __NL__, retval);
-}
+}

src/debug/recorder_debug.hpp

@@ -2,5 +2,17 @@
 #define __DEBUG_RECORDER_H__
 #include "cli/menu.hpp"
 
+/**
+ * @brief Contains tests for various recorder functions
+ * @details Functions able to be tested:
+ * - if recorder has data
+ * - if we can retrieve the number of files in filesystem
+ * - if we can retrieve the last packet in memory
+ * - if we can open & close a recording session
+ * - if we can input bytes into data buffer
+ * - if we can create session & store in session of byte size inputted by user
+ * - if we can set start time of a session
+ * - if we can pop the last packet in memory
+ */
 extern const Menu_t Recorder_debug_menu[];
 #endif