diff options
Diffstat (limited to 'include/gwin/console.h')
-rw-r--r-- | include/gwin/console.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/include/gwin/console.h b/include/gwin/console.h index fba27584..99c9232c 100644 --- a/include/gwin/console.h +++ b/include/gwin/console.h @@ -24,6 +24,12 @@ * @defgroup 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
+ *
* @{
*/
|