Added doxygen comments for the main eurephiadm parts

1 files changed, 21 insertions, 2 deletions

diff --git a/eurephiadm/get_console_input.c b/eurephiadm/get_console_input.c
index c64cefd..8914d7b 100644
--- a/eurephiadm/get_console_input.c
+++ b/eurephiadm/get_console_input.c
@@ -19,10 +19,31 @@
  *
  */
 
+/**
+ * @file   get_console_input.c
+ * @author David Sommerseth <dazo@users.sourceforge.net>
+ * @date   2008-11-29
+ *
+ * @brief   Simple function to retrieve user input from the console
+ *
+ */
+
 #include <stdio.h>
 #include <termios.h>
 #include <string.h>
 
+
+/**
+ * Prints a prompt to the screen and waits for user input via the tty.
+ *
+ * @param buf     char* to the buffer where the user input is to be stored.
+ * @param len     size of the input buffer
+ * @param prompt  String printed before the user is asked for input
+ * @param hidden  If set to 1, the user input will not be echoed to the tty,
+ *                which is useful for passwords.
+ *
+ * @return Returns the number of bytes received from the user.  On error -1 is returned
+ */
 int get_console_input(char *buf, size_t len, const char *prompt, int hidden) {
         struct termios term_orig, term_noecho;
         char *ptr;
@@ -66,5 +87,3 @@ int get_console_input(char *buf, size_t len, const char *prompt, int hidden) {
 
         return (buf != NULL ? strlen(buf) : -1); 
 }
-
-