From b9c103e3048d2b28a2606a3b9693ec881425a732 Mon Sep 17 00:00:00 2001
From: Marvin Borner
Date: Sat, 28 Sep 2019 23:08:13 +0200
Subject: Added some documentation

---
 src/kernel/graphics/graphics.h | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

(limited to 'src/kernel/graphics/graphics.h')

diff --git a/src/kernel/graphics/graphics.h b/src/kernel/graphics/graphics.h
index 3136b1e..e20d1ed 100644
--- a/src/kernel/graphics/graphics.h
+++ b/src/kernel/graphics/graphics.h
@@ -5,21 +5,53 @@
 #include <stdint.h>
 #include "vesa.h"
 
-// VGA
+/**
+ * Linked table of colors and hardware color codes
+ */
 enum vga_color;
 
+/**
+ * Initialize the terminal color and cursor position
+ */
 void terminal_initialize(void);
 
+/**
+ * Set the terminal color to a specified hardware color code
+ * @see enum vga_color
+ * @param color
+ */
 void terminal_set_color(uint8_t color);
 
+/**
+ * Clear the entire terminal screen
+ */
 void terminal_clear();
 
+/**
+ * Write a string to the terminal
+ * @param data The string that should be written
+ */
 void terminal_write_string(const char *data);
 
+/**
+ * Put a new char at the x+1 cursor position and
+ * handle according events (e.g. overflow, linebreak)
+ * @param c The character (can also be \n or \r)
+ */
 void terminal_put_char(char c);
 
+/**
+ * Put a new char at the x+1 cursor position,
+ * handle according events (e.g. overflow, linebreak) and
+ * execute the current command if c is linebreak (\n)
+ * @param c The character (can also be \n or \r)
+ */
 void terminal_put_keyboard_char(char c);
 
+/**
+ * Write a line to the terminal
+ * @param data The line (string) that should be written
+ */
 void terminal_write_line(const char *data);
 
 #endif
\ No newline at end of file
-- 
cgit v1.2.3