uGFX/ugfx
2
0
Fork 0
Code Issues 2 Pull requests Projects Releases Wiki Activity

doxygen update

Browse source
This commit is contained in:
Joel Bodenmann 2013-07-17 04:44:29 +02:00
parent d900257ded
commit d1861f04e0
7 changed files with 16 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
include/gwin/gwidget.h
View file

@ -143,6 +143,8 @@ void gwinSetDefaultStyle(const GWidgetStyle *pstyle, bool_t updateAll);
/** /**
* @brief Get the current default style. * @brief Get the current default style.
* *
* @return The current default style.
*
* @api * @api
*/ */
const GWidgetStyle *gwinGetDefaultStyle(void); const GWidgetStyle *gwinGetDefaultStyle(void);

8
include/gwin/gwin.h
View file

@ -114,6 +114,8 @@ extern "C" {
/** /**
* @brief Get the default foreground color for all new GWIN windows * @brief Get the default foreground color for all new GWIN windows
* *
* @return The current default color for all new GWIN windows
*
* @api * @api
*/ */
color_t gwinGetDefaultColor(void); color_t gwinGetDefaultColor(void);
@ -130,6 +132,8 @@ extern "C" {
/** /**
* @brief Get the default background color for all new GWIN windows * @brief Get the default background color for all new GWIN windows
* *
* @return The current default background color for all new GWIN windows
*
* @api * @api
*/ */
color_t gwinGetDefaultBgColor(void); color_t gwinGetDefaultBgColor(void);
@ -191,9 +195,11 @@ extern "C" {
* *
* @param[in] gh The window * @param[in] gh The window
* *
* @return A string describing the object class.
*
* @api * @api
*/ */
const char *gwinGetClassName(GHandle gh); const char* gwinGetClassName(GHandle gh);
/** /**
* @brief Get an ID that uniquely describes the class of the GHandle * @brief Get an ID that uniquely describes the class of the GHandle

2
include/gwin/image.h
View file

@ -96,7 +96,7 @@ bool_t gwinImageOpenMemory(GHandle gh, const void* memory);
* @brief Cache the image. * @brief Cache the image.
* @details Decodes and caches the current frame into RAM. * @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. * @return GDISP_IMAGE_ERR_OK (0) on success or an error code.
* *

2
include/gwin/label.h
View file

@ -43,7 +43,7 @@ extern "C" {
* @details A label widget is a simple window which has a static text. * @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] 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. * @return NULL if there is no resultat drawing area, otherwise the widget handle.
* *

4
include/gwin/radio.h
View file

@ -102,7 +102,9 @@ bool_t gwinRadioIsPressed(GHandle gh);
* @brief Find the currently pressed radio button in the specified group * @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 * @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 * @api
*/ */

2
src/gwin/gimage.c
View file

@ -6,7 +6,7 @@
*/ */
/** /**
* @file src/gwin/image.c * @file src/gwin/gimage.c
* @brief GWIN sub-system image code. * @brief GWIN sub-system image code.
*/ */

1
src/gwin/label.c
View file

@ -115,4 +115,5 @@ GHandle gwinLabelCreate(GLabelObject *widget, GWidgetInit *pInit) {
} }
#endif // GFX_USE_GWIN && GFX_NEED_LABEL #endif // GFX_USE_GWIN && GFX_NEED_LABEL
/** @} */