diff options
| author | Joel Bodenmann <joel@unormal.org> | 2012-12-18 22:49:01 +0100 |
|---|---|---|
| committer | Joel Bodenmann <joel@unormal.org> | 2012-12-18 22:49:01 +0100 |
| commit | 5c6027d14d168a7210ed6edd8c8b7506842fd7b0 (patch) | |
| tree | ae6cf98aaed83854070ba39de0079a0aec1cc1a5 /include/gwin/console.h | |
| parent | 6e76ecde180dc1d12d211d7dca14f0a66d8b24f8 (diff) | |
| download | uGFX-5c6027d14d168a7210ed6edd8c8b7506842fd7b0.tar.gz uGFX-5c6027d14d168a7210ed6edd8c8b7506842fd7b0.tar.bz2 uGFX-5c6027d14d168a7210ed6edd8c8b7506842fd7b0.zip | |
some more doxygen
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
+ *
* @{
*/
|