docs: changes to variable documentation

src/cli/conio.cpp

@@ -1,11 +1,10 @@
 /**
-* Project smartfin-fw3
-* @file conio.hpp
-* Description: Particle serial input and output for command line use
-* @author \@emilybthorpe
-* @date Jul 20 2023
-*/
-
+ * Project smartfin-fw3
+ * @file conio.hpp
+ * Description: Particle serial input and output for command line use
+ * @author Emily B. Thorpe <[email protected]>
+ * @date Jul 20 2023
+ */
 
 #include "conio.hpp"
 

src/cli/conio.hpp

@@ -45,7 +45,8 @@ 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'
+     * @return int value of user inputs in the buffer array until
+     * backspace clicked('\\b')
      */
     int getline(char* buffer, int buflen);