aboutsummaryrefslogtreecommitdiffstats
path: root/src/gwin/gwin.h
diff options
context:
space:
mode:
authorinmarket <andrewh@inmarket.com.au>2015-10-06 12:01:29 +1000
committerinmarket <andrewh@inmarket.com.au>2015-10-06 12:01:29 +1000
commit25482f5c901e8c20d8b1110ea802f61dfac98ec8 (patch)
tree1c6f9c0697cbdf817cda41ff9f79e200cbebfeaa /src/gwin/gwin.h
parent470868f51a9a937f0a045ca2081e4183bc76ec0c (diff)
downloaduGFX-25482f5c901e8c20d8b1110ea802f61dfac98ec8.tar.gz
uGFX-25482f5c901e8c20d8b1110ea802f61dfac98ec8.tar.bz2
uGFX-25482f5c901e8c20d8b1110ea802f61dfac98ec8.zip
Doco improvement
Diffstat (limited to 'src/gwin/gwin.h')
-rw-r--r--src/gwin/gwin.h31
1 files changed, 18 insertions, 13 deletions
diff --git a/src/gwin/gwin.h b/src/gwin/gwin.h
index 4a7d02bf..cc0d44f1 100644
--- a/src/gwin/gwin.h
+++ b/src/gwin/gwin.h
@@ -38,19 +38,22 @@ typedef struct GWindowObject *GHandle;
typedef struct GWindowObject {
#if GWIN_NEED_WINDOWMANAGER
// This MUST be the first member of the structure
- gfxQueueASyncItem wmq; // @< The next window (for the window manager)
+ gfxQueueASyncItem wmq; /**< The next window (for the window manager) */
#endif
- const struct gwinVMT *vmt; // @< The VMT for this GWIN
- GDisplay * display; // @< The display this window is on.
- coord_t x, y; // @< Screen relative position
- coord_t width, height; // @< Dimensions of this window
- color_t color, bgcolor; // @< The current drawing colors
- uint32_t flags; // @< Window flags (the meaning is private to the GWIN class)
+ const struct gwinVMT* vmt; /**< The VMT for this GWIN */
+ GDisplay * display; /**< The display this window is on */
+ coord_t x; /**< The position relative to the screen */
+ coord_t y; /**< The position relative to the screen */
+ coord_t width; /**< The width of this window */
+ coord_t height; /**< The height of this window */
+ color_t color; /**< The current foreground drawing color */
+ color_t bgcolor; /**< The current background drawing color */
+ uint32_t flags; /**< Window flags (the meaning is private to the GWIN class) */
#if GDISP_NEED_TEXT
- font_t font; // @< The current font
+ font_t font; /**< The current font */
#endif
#if GWIN_NEED_CONTAINERS
- GHandle parent; // @< The parent window
+ GHandle parent; /**< The parent window */
#endif
} GWindowObject, * GHandle;
/** @} */
@@ -68,11 +71,13 @@ typedef struct GWindowObject {
* @{
*/
typedef struct GWindowInit {
- coord_t x, y; // @< The initial position relative to its parent
- coord_t width, height; // @< The initial dimension
- bool_t show; // @< Should the window be visible initially
+ coord_t x; /**< The initial position relative to its parent */
+ coord_t y; /**< The initial position relative to its parent */
+ coord_t width; /**< The width */
+ coord_t height; /**< The height */
+ bool_t show; /**< Should the window be visible initially */
#if GWIN_NEED_CONTAINERS
- GHandle parent; // @< The parent - must be a container or NULL
+ GHandle parent; /**< The parent - must be a container or NULL */
#endif
} GWindowInit;
/** @} */