summaryrefslogtreecommitdiff
path: root/kern/inc/console.h
diff options
context:
space:
mode:
Diffstat (limited to 'kern/inc/console.h')
-rw-r--r--kern/inc/console.h15
1 files changed, 15 insertions, 0 deletions
diff --git a/kern/inc/console.h b/kern/inc/console.h
index dbfdbb0..050b04b 100644
--- a/kern/inc/console.h
+++ b/kern/inc/console.h
@@ -9,6 +9,21 @@
#ifndef _CONSOLE_H
#define _CONSOLE_H
+/** @brief Prints character ch at the current location
+ * of the cursor.
+ *
+ * If the character is a newline ('\n'), the cursor is
+ * be moved to the beginning of the next line (scrolling if necessary). If
+ * the character is a carriage return ('\r'), the cursor
+ * is immediately reset to the beginning of the current
+ * line, causing any future output to overwrite any existing
+ * output on the line. If backsapce ('\b') is encountered,
+ * the previous character is erased. See the main console.c description
+ * for more backspace behavior.
+ *
+ * @param ch the character to print
+ * @return The input character
+ */
int putbyte(char ch);
#endif