aboutsummaryrefslogtreecommitdiffstats
path: root/include/gwin/gwin.h
diff options
context:
space:
mode:
authorJoel Bodenmann <joel@unormal.org>2013-07-17 04:44:29 +0200
committerJoel Bodenmann <joel@unormal.org>2013-07-17 04:44:29 +0200
commitd1861f04e04608facbbda43aea4b5fb5004e8dcc (patch)
tree31fca34e2f6eaef296f541e4ea470b7608df0aaf /include/gwin/gwin.h
parentd900257dedd03401d3029cede5ab8aa8f826ca24 (diff)
downloaduGFX-d1861f04e04608facbbda43aea4b5fb5004e8dcc.tar.gz
uGFX-d1861f04e04608facbbda43aea4b5fb5004e8dcc.tar.bz2
uGFX-d1861f04e04608facbbda43aea4b5fb5004e8dcc.zip
doxygen update
Diffstat (limited to 'include/gwin/gwin.h')
-rw-r--r--include/gwin/gwin.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/include/gwin/gwin.h b/include/gwin/gwin.h
index 37c2a4e8..a2c0d0a1 100644
--- a/include/gwin/gwin.h
+++ b/include/gwin/gwin.h
@@ -114,6 +114,8 @@ extern "C" {
/**
* @brief Get the default foreground color for all new GWIN windows
*
+ * @return The current default color for all new GWIN windows
+ *
* @api
*/
color_t gwinGetDefaultColor(void);
@@ -130,6 +132,8 @@ extern "C" {
/**
* @brief Get the default background color for all new GWIN windows
*
+ * @return The current default background color for all new GWIN windows
+ *
* @api
*/
color_t gwinGetDefaultBgColor(void);
@@ -191,9 +195,11 @@ extern "C" {
*
* @param[in] gh The window
*
+ * @return A string describing the object class.
+ *
* @api
*/
- const char *gwinGetClassName(GHandle gh);
+ const char* gwinGetClassName(GHandle gh);
/**
* @brief Get an ID that uniquely describes the class of the GHandle