diff options
| author | Joel Bodenmann <joel@unormal.org> | 2013-07-17 04:44:29 +0200 |
|---|---|---|
| committer | Joel Bodenmann <joel@unormal.org> | 2013-07-17 04:44:29 +0200 |
| commit | d1861f04e04608facbbda43aea4b5fb5004e8dcc (patch) | |
| tree | 31fca34e2f6eaef296f541e4ea470b7608df0aaf /include/gwin | |
| parent | d900257dedd03401d3029cede5ab8aa8f826ca24 (diff) | |
| download | uGFX-d1861f04e04608facbbda43aea4b5fb5004e8dcc.tar.gz uGFX-d1861f04e04608facbbda43aea4b5fb5004e8dcc.tar.bz2 uGFX-d1861f04e04608facbbda43aea4b5fb5004e8dcc.zip | |
doxygen update
Diffstat (limited to 'include/gwin')
| -rw-r--r-- | include/gwin/gwidget.h | 2 | ||||
| -rw-r--r-- | include/gwin/gwin.h | 8 | ||||
| -rw-r--r-- | include/gwin/image.h | 2 | ||||
| -rw-r--r-- | include/gwin/label.h | 2 | ||||
| -rw-r--r-- | include/gwin/radio.h | 4 |
5 files changed, 14 insertions, 4 deletions
diff --git a/include/gwin/gwidget.h b/include/gwin/gwidget.h index 222a3af5..0dea41ba 100644 --- a/include/gwin/gwidget.h +++ b/include/gwin/gwidget.h @@ -143,6 +143,8 @@ void gwinSetDefaultStyle(const GWidgetStyle *pstyle, bool_t updateAll); /** * @brief Get the current default style. * + * @return The current default style. + * * @api */ const GWidgetStyle *gwinGetDefaultStyle(void); 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 diff --git a/include/gwin/image.h b/include/gwin/image.h index 7eb2d969..142f6374 100644 --- a/include/gwin/image.h +++ b/include/gwin/image.h @@ -96,7 +96,7 @@ bool_t gwinImageOpenMemory(GHandle gh, const void* memory); * @brief Cache the image. * @details Decodes and caches the current frame into RAM. * - * param[in] gh The widget (must be an image widget) + * @param[in] gh The widget (must be an image widget) * * @return GDISP_IMAGE_ERR_OK (0) on success or an error code. * diff --git a/include/gwin/label.h b/include/gwin/label.h index 4362b035..6fc14c1a 100644 --- a/include/gwin/label.h +++ b/include/gwin/label.h @@ -43,7 +43,7 @@ extern "C" { * @details A label widget is a simple window which has a static text. * * @param[in] widget The label structure to initialise. If this is NULL, the structure is dynamically allocated. - * @param[in] pinit The initialisation parameters to use. + * @param[in] pInit The initialisation parameters to use. * * @return NULL if there is no resultat drawing area, otherwise the widget handle. * diff --git a/include/gwin/radio.h b/include/gwin/radio.h index 1e0a2dd6..81243da4 100644 --- a/include/gwin/radio.h +++ b/include/gwin/radio.h @@ -102,7 +102,9 @@ bool_t gwinRadioIsPressed(GHandle gh); * @brief Find the currently pressed radio button in the specified group * @return The handle of the pressed radio button or NULL if none are pressed * - * @param[in] gh The window handle (must be a radio widget) + * @param[in] group The radio button group to be examined + * + * @return The handle of the currently pressed radio button * * @api */ |