docs: added and fixed method and variable docs

UCSD-E4E · Nov 14, 2024 · d7cc478 · d7cc478
1 parent fcb09e1
commit d7cc478
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/src/cli/conio.cpp b/src/cli/conio.cpp
@@ -2,7 +2,7 @@
 * Project smartfin-fw3
 * @file conio.hpp
 * Description: Particle serial input and output for command line use
-* @author @emilybthorpe
+* @author \@emilybthorpe
 * @date Jul 20 2023
 */
 

diff --git a/src/cli/conio.hpp b/src/cli/conio.hpp
@@ -3,6 +3,10 @@
 
 #include <stdint.h>
 
+/**
+ * @brief int length of character array SF_OSAL_printfBuffer
+ *
+ */
 #define SF_OSAL_PRINTF_BUFLEN   1536
 
 #ifdef __cplusplus
@@ -41,6 +45,7 @@ extern "C"
      * @brief Gets user input lin
      * @param buffer buffer to write too
      * @param buflen length of buffer
+     * @return int value of user inputs in the buffer array excluding '\b'
      */
     int getline(char* buffer, int buflen);