aboutsummaryrefslogtreecommitdiffstats
path: root/include/gwin/console.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/gwin/console.h')
-rw-r--r--include/gwin/console.h11
1 files changed, 10 insertions, 1 deletions
diff --git a/include/gwin/console.h b/include/gwin/console.h
index 4e78d747..9fa867c8 100644
--- a/include/gwin/console.h
+++ b/include/gwin/console.h
@@ -21,9 +21,18 @@
* @file include/gwin/console.h
* @brief GWIN Graphic window subsystem header file.
*
- * @addtogroup GWIN
+ * @defgroup Console Console
+ * @ingroup GWIN
+ *
+ * @details GWIN allows it to create a console/terminal like window.
+ * You can simply use chprintf() to print to the terminal.
+ *
+ * @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
+ * @pre GWIN_NEED_CONSOLE must be set to TRUE in your gfxconf.h
+ *
* @{
*/
+
#ifndef _GWIN_CONSOLE_H
#define _GWIN_CONSOLE_H