diff options
author | Joel Bodenmann <joel@seriouslyembedded.com> | 2015-08-16 00:42:22 +0200 |
---|---|---|
committer | Joel Bodenmann <joel@seriouslyembedded.com> | 2015-08-16 00:42:22 +0200 |
commit | ef813f44d3c10aac784f9adc7ce66509d1f31d7e (patch) | |
tree | 8a704b61eb87e9bfcc8b39fcd88e0f4a0630073f /src/gwin/gwin.h | |
parent | 668b161f0eead1b9687305281eb59be0e0713bbe (diff) | |
download | uGFX-ef813f44d3c10aac784f9adc7ce66509d1f31d7e.tar.gz uGFX-ef813f44d3c10aac784f9adc7ce66509d1f31d7e.tar.bz2 uGFX-ef813f44d3c10aac784f9adc7ce66509d1f31d7e.zip |
Improving doxygen
Diffstat (limited to 'src/gwin/gwin.h')
-rw-r--r-- | src/gwin/gwin.h | 31 |
1 files changed, 18 insertions, 13 deletions
diff --git a/src/gwin/gwin.h b/src/gwin/gwin.h index 329be4c4..4b29f1ee 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; /** @} */ |