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

Reworking the GWIN doxygen documentation.

Browse Source
This commit is contained in:
Joel Bodenmann 2014-05-20 18:05:38 +02:00
parent 9781c31f3b
commit 0b204ed8e3
36 changed files with 168 additions and 158 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Doxygenfile
View File

@ -536,7 +536,7 @@ INLINE_INFO = YES
# name. If set to NO the members will appear in declaration order. # name. If set to NO the members will appear in declaration order.
# The default value is: YES. # The default value is: YES.
SORT_MEMBER_DOCS = NO SORT_MEMBER_DOCS = YES
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member # descriptions of file, namespace and class members alphabetically by member

21
docs/src/containers.dox Normal file
View File

@ -0,0 +1,21 @@
/*
* This file is subject to the terms of the GFX License. If a copy of
* the license was not distributed with this file, you can obtain one at:
*
* http://ugfx.com/license.html
*/
/**
* @file src/gwin/sys_defs.h
*
* @defgroup Containers Containers
* @ingroup GWIN
*
* @details Containers are a "super-class" of a widget. Containers can have
* children windows which they can place within their borders. Containers
* control the visibility and enabled state of their children. By making
* a container invisible you make all its children invisible. Similiarly
* with the enabled state.
*
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
*/

28
docs/src/widgets.dox Normal file
View File

@ -0,0 +1,28 @@
/*
* This file is subject to the terms of the GFX License. If a copy of
* the license was not distributed with this file, you can obtain one at:
*
* http://ugfx.com/license.html
*/
/**
* @file src/gwin/sys_defs.h
*
* @defgroup Widgets Widgets
* @ingroup GWIN
*
* @details Widgets are a "super-class" of a window that provides the
* following extra features:
* <ul>
* <li>Widgets can always redraw themselves
* <li>Widgets are able to accept user input such as from a touchscreen/toggle/dial/keyboard
* <li>Widgets can have their drawing routine overwritten to provide fancier versions of
* the object. For example, their are predefined drawing routines for round buttons,
* image buttons, arrow buttons etc. along with the normal button drawing routine.
* <li>Widgets support a "style". By changing the style you can affect the colours
* used to draw the widget similar to the way you can apply color schemes
* in Windows and Linux.
* </ul>
*
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
*/

31
docs/src/windows.dox Normal file
View File

@ -0,0 +1,31 @@
/*
* This file is subject to the terms of the GFX License. If a copy of
* the license was not distributed with this file, you can obtain one at:
*
* http://ugfx.com/license.html
*/
/**
* @file src/gwin/sys_defs.h
*
* @defgroup Windows Windows
* @ingroup GWIN
*
* @details The window is the most basic GWIN element. All the other windows,
* widgets and containers are based on this class.
*
* A window implements the following properties and attributes:
* <ul>
* <li>Position</li>
* <li>Size</li>
* <li>Foreground color</li>
* <li>Background color</li>
* </ul>
*
* Each Window can either be created statically or dynamically.
* Like any other good window system, uGFX provide some standard window
* types such as graphs, consoles, buttons, containers etc. This is done
* through "super-classing" basic windows to provide the extended capabilities.
*
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
*/

4
src/gadc/driver.h
View File

@ -36,7 +36,7 @@ typedef struct GadcTimerJob_t {
size_t todo; // @< How many conversions to do size_t todo; // @< How many conversions to do
size_t done; // @< How many conversions have already been done size_t done; // @< How many conversions have already been done
} GadcTimerJob; } GadcTimerJob;
/* @} */ /** @} */
/** /**
* @brief The structure passed to do a single conversion * @brief The structure passed to do a single conversion
@ -46,7 +46,7 @@ typedef struct GadcNonTimerJob_t {
uint32_t physdev; // @< The physical device/s. The exact meaning of physdev is hardware dependent. uint32_t physdev; // @< The physical device/s. The exact meaning of physdev is hardware dependent.
adcsample_t *buffer; // @< Where to put the samples. adcsample_t *buffer; // @< Where to put the samples.
} GadcNonTimerJob; } GadcNonTimerJob;
/* @} */ /** @} */
/*===========================================================================*/ /*===========================================================================*/
/* External declarations. */ /* External declarations. */

2
src/gadc/sys_defs.h
View File

@ -178,7 +178,7 @@ void gadcHighSpeedSetISRCallback(GADCISRCallbackFunction isrfn);
*/ */
GDataBuffer *gadcHighSpeedGetData(delaytime_t ms); GDataBuffer *gadcHighSpeedGetData(delaytime_t ms);
GDataBuffer *gadcHighSpeedGetDataI(void); GDataBuffer *gadcHighSpeedGetDataI(void);
/* @} */ /** @} */
/** /**
* @brief Start the high speed ADC conversions. * @brief Start the high speed ADC conversions.

2
src/gmisc/sys_defs.h
View File

@ -64,7 +64,7 @@ typedef int32_t fixed;
#define FIXED0_5 32768 /* @< 0.5 as a fixed (used for rounding) */ #define FIXED0_5 32768 /* @< 0.5 as a fixed (used for rounding) */
#define FP2FIXED(x) ((fixed)((x)*65536.0)) /* @< floating point to fixed */ #define FP2FIXED(x) ((fixed)((x)*65536.0)) /* @< floating point to fixed */
#define FIXED2FP(x) ((double)(x)/65536.0) /* @< fixed to floating point */ #define FIXED2FP(x) ((double)(x)/65536.0) /* @< fixed to floating point */
/* @} */ /** @} */
/** /**
* @brief The famous number pi * @brief The famous number pi

4
src/gos/sys_defs.h
View File

@ -58,7 +58,7 @@
*/ */
#define DECLARE_THREAD_FUNCTION(fnName, param) threadreturn_t fnName(void *param) #define DECLARE_THREAD_FUNCTION(fnName, param) threadreturn_t fnName(void *param)
#define DECLARE_THREAD_STACK(name, sz) uint8_t name[sz]; #define DECLARE_THREAD_STACK(name, sz) uint8_t name[sz];
/* @} */ /** @} */
/** /**
* @} * @}
@ -75,7 +75,7 @@
#define LOW_PRIORITY 0 #define LOW_PRIORITY 0
#define NORMAL_PRIORITY 1 #define NORMAL_PRIORITY 1
#define HIGH_PRIORITY 2 #define HIGH_PRIORITY 2
/* @} */ /** @} */
/** /**
* @brief A semaphore * @brief A semaphore

34
src/gqueue/sys_defs.h
View File

@ -45,7 +45,7 @@ typedef struct gfxQueueFSyncItem {
struct gfxQueueFSyncItem *next; struct gfxQueueFSyncItem *next;
gfxSem sem; gfxSem sem;
} gfxQueueFSyncItem; } gfxQueueFSyncItem;
/* @} */ /** @} */
/** /**
* @brief A queue * @brief A queue
@ -67,7 +67,7 @@ typedef struct gfxQueueFSync {
gfxQueueFSyncItem *tail; gfxQueueFSyncItem *tail;
gfxSem sem; gfxSem sem;
} gfxQueueFSync; } gfxQueueFSync;
/* @} */ /** @} */
/** /**
* @brief A Data Buffer Queue * @brief A Data Buffer Queue
@ -104,7 +104,7 @@ extern "C" {
void gfxQueueASyncInit(gfxQueueASync *pqueue); void gfxQueueASyncInit(gfxQueueASync *pqueue);
void gfxQueueGSyncInit(gfxQueueGSync *pqueue); void gfxQueueGSyncInit(gfxQueueGSync *pqueue);
void gfxQueueFSyncInit(gfxQueueFSync *pqueue); void gfxQueueFSyncInit(gfxQueueFSync *pqueue);
/* @} */ /** @} */
/** /**
* @brief De-Initialise a queue. * @brief De-Initialise a queue.
@ -117,7 +117,7 @@ void gfxQueueFSyncInit(gfxQueueFSync *pqueue);
#define gfxQueueASyncDeinit(pqueue) #define gfxQueueASyncDeinit(pqueue)
void gfxQueueGSyncDeinit(gfxQueueGSync *pqueue); void gfxQueueGSyncDeinit(gfxQueueGSync *pqueue);
void gfxQueueFSyncDeinit(gfxQueueFSync *pqueue); void gfxQueueFSyncDeinit(gfxQueueFSync *pqueue);
/* @} */ /** @} */
/** /**
* @brief Get an item from the head of the queue (and remove it from the queue). * @brief Get an item from the head of the queue (and remove it from the queue).
@ -137,7 +137,7 @@ gfxQueueASyncItem *gfxQueueASyncGetI(gfxQueueASync *pqueue);
gfxQueueGSyncItem *gfxQueueGSyncGet(gfxQueueGSync *pqueue, delaytime_t ms); gfxQueueGSyncItem *gfxQueueGSyncGet(gfxQueueGSync *pqueue, delaytime_t ms);
gfxQueueGSyncItem *gfxQueueGSyncGetI(gfxQueueGSync *pqueue); gfxQueueGSyncItem *gfxQueueGSyncGetI(gfxQueueGSync *pqueue);
gfxQueueFSyncItem *gfxQueueFSyncGet(gfxQueueFSync *pqueue, delaytime_t ms); gfxQueueFSyncItem *gfxQueueFSyncGet(gfxQueueFSync *pqueue, delaytime_t ms);
/* @} */ /** @} */
/** /**
* @brief Put an item on the end of the queue. * @brief Put an item on the end of the queue.
@ -160,7 +160,7 @@ void gfxQueueASyncPutI(gfxQueueASync *pqueue, gfxQueueASyncItem *pitem);
void gfxQueueGSyncPut(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem); void gfxQueueGSyncPut(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem);
void gfxQueueGSyncPutI(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem); void gfxQueueGSyncPutI(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem);
bool_t gfxQueueFSyncPut(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, delaytime_t ms); bool_t gfxQueueFSyncPut(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, delaytime_t ms);
/* @} */ /** @} */
/** /**
* @brief Pop an item from the head of the queue (and remove it from the queue). * @brief Pop an item from the head of the queue (and remove it from the queue).
@ -173,7 +173,7 @@ bool_t gfxQueueFSyncPut(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, delayti
#define gfxQueueASyncPopI(pqueue) gfxQueueASyncGetI(pqueue) #define gfxQueueASyncPopI(pqueue) gfxQueueASyncGetI(pqueue)
#define gfxQueueGSyncPop(pqueue, ms) gfxQueueGSyncGet(pqueue, ms) #define gfxQueueGSyncPop(pqueue, ms) gfxQueueGSyncGet(pqueue, ms)
#define gfxQueueFSyncPop(pqueue, ms) gfxQueueFSyncGet(pqueue, ms) #define gfxQueueFSyncPop(pqueue, ms) gfxQueueFSyncGet(pqueue, ms)
/* @} */ /** @} */
/** /**
* @brief Push an item into the start of the queue. * @brief Push an item into the start of the queue.
@ -196,7 +196,7 @@ void gfxQueueASyncPushI(gfxQueueASync *pqueue, gfxQueueASyncItem *pitem);
void gfxQueueGSyncPush(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem); void gfxQueueGSyncPush(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem);
void gfxQueueGSyncPushI(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem); void gfxQueueGSyncPushI(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem);
bool_t gfxQueueFSyncPush(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, delaytime_t ms); bool_t gfxQueueFSyncPush(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, delaytime_t ms);
/* @} */ /** @} */
/** /**
* @brief Insert an item on the queue after the specified item. * @brief Insert an item on the queue after the specified item.
@ -221,7 +221,7 @@ void gfxQueueASyncInsertI(gfxQueueASync *pqueue, gfxQueueASyncItem *pitem, gfxQu
void gfxQueueGSyncInsert(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem, gfxQueueASyncItem *pafter); void gfxQueueGSyncInsert(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem, gfxQueueASyncItem *pafter);
void gfxQueueGSyncInsertI(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem, gfxQueueASyncItem *pafter); void gfxQueueGSyncInsertI(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem, gfxQueueASyncItem *pafter);
bool_t gfxQueueFSyncInsert(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, gfxQueueASyncItem *pafter, delaytime_t ms); bool_t gfxQueueFSyncInsert(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, gfxQueueASyncItem *pafter, delaytime_t ms);
/* @} */ /** @} */
/** /**
* @brief Remove an item from the queue. * @brief Remove an item from the queue.
@ -243,7 +243,7 @@ void gfxQueueASyncRemoveI(gfxQueueASync *pqueue, gfxQueueASyncItem *pitem);
void gfxQueueGSyncRemove(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem); void gfxQueueGSyncRemove(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem);
void gfxQueueGSyncRemoveI(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem); void gfxQueueGSyncRemoveI(gfxQueueGSync *pqueue, gfxQueueGSyncItem *pitem);
void gfxQueueFSyncRemove(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem); void gfxQueueFSyncRemove(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem);
/* @} */ /** @} */
/** /**
* @brief Is the queue empty? * @brief Is the queue empty?
@ -262,7 +262,7 @@ void gfxQueueFSyncRemove(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem);
#define gfxQueueGSyncIsEmptyI(pqueue) ((pqueue)->head == 0) #define gfxQueueGSyncIsEmptyI(pqueue) ((pqueue)->head == 0)
#define gfxQueueFSyncIsEmpty(pqueue) ((pqueue)->head == 0) #define gfxQueueFSyncIsEmpty(pqueue) ((pqueue)->head == 0)
#define gfxQueueFSyncIsEmptyI(pqueue) ((pqueue)->head == 0) #define gfxQueueFSyncIsEmptyI(pqueue) ((pqueue)->head == 0)
/* @} */ /** @} */
/** /**
* @brief Is an item in the queue? * @brief Is an item in the queue?
@ -283,7 +283,7 @@ bool_t gfxQueueGSyncIsIn(gfxQueueGSync *pqueue, const gfxQueueGSyncItem *pitem);
bool_t gfxQueueGSyncIsInI(gfxQueueGSync *pqueue, const gfxQueueGSyncItem *pitem); bool_t gfxQueueGSyncIsInI(gfxQueueGSync *pqueue, const gfxQueueGSyncItem *pitem);
bool_t gfxQueueFSyncIsIn(gfxQueueFSync *pqueue, const gfxQueueFSyncItem *pitem); bool_t gfxQueueFSyncIsIn(gfxQueueFSync *pqueue, const gfxQueueFSyncItem *pitem);
bool_t gfxQueueFSyncIsInI(gfxQueueFSync *pqueue, const gfxQueueFSyncItem *pitem); bool_t gfxQueueFSyncIsInI(gfxQueueFSync *pqueue, const gfxQueueFSyncItem *pitem);
/* @} */ /** @} */
/** /**
* @brief Get the first item from the head of the queue but do not remove it from the queue. * @brief Get the first item from the head of the queue but do not remove it from the queue.
@ -307,7 +307,7 @@ bool_t gfxQueueFSyncIsInI(gfxQueueFSync *pqueue, const gfxQueueFSyncItem *pitem)
#define gfxQueueGSyncPeekI(pqueue) ((const gfxQueueGSyncItem *)((pqueue)->head)) #define gfxQueueGSyncPeekI(pqueue) ((const gfxQueueGSyncItem *)((pqueue)->head))
#define gfxQueueFSyncPeek(pqueue) ((const gfxQueueFSyncItem *)((pqueue)->head)) #define gfxQueueFSyncPeek(pqueue) ((const gfxQueueFSyncItem *)((pqueue)->head))
#define gfxQueueFSyncPeekI(pqueue) ((const gfxQueueFSyncItem *)((pqueue)->head)) #define gfxQueueFSyncPeekI(pqueue) ((const gfxQueueFSyncItem *)((pqueue)->head))
/* @} */ /** @} */
/** /**
* @brief Get the next item in the queue (but do not remove it from the queue). * @brief Get the next item in the queue (but do not remove it from the queue).
@ -331,7 +331,7 @@ bool_t gfxQueueFSyncIsInI(gfxQueueFSync *pqueue, const gfxQueueFSyncItem *pitem)
#define gfxQueueGSyncNextI(pitem) ((const gfxQueueGSyncItem *)((pitem)->next)) #define gfxQueueGSyncNextI(pitem) ((const gfxQueueGSyncItem *)((pitem)->next))
#define gfxQueueFSyncNext(pitem) ((const gfxQueueFSyncItem *)((pitem)->next)) #define gfxQueueFSyncNext(pitem) ((const gfxQueueFSyncItem *)((pitem)->next))
#define gfxQueueFSyncNextI(pitem) ((const gfxQueueFSyncItem *)((pitem)->next)) #define gfxQueueFSyncNextI(pitem) ((const gfxQueueFSyncItem *)((pitem)->next))
/* @} */ /** @} */
/** /**
* @brief Allocate some buffers and put them on the free list * @brief Allocate some buffers and put them on the free list
@ -352,7 +352,7 @@ bool_t gfxBufferAlloc(unsigned num, size_t size);
* @{ * @{
*/ */
bool_t gfxBufferIsAvailable(void); bool_t gfxBufferIsAvailable(void);
/* @} */ /** @} */
/** /**
* @brief Get a buffer from the free list * @brief Get a buffer from the free list
@ -365,7 +365,7 @@ bool_t gfxBufferIsAvailable(void);
*/ */
GDataBuffer *gfxBufferGet(delaytime_t ms); GDataBuffer *gfxBufferGet(delaytime_t ms);
GDataBuffer *gfxBufferGetI(void); GDataBuffer *gfxBufferGetI(void);
/* @} */ /** @} */
/** /**
* @brief Release a buffer back to the free list * @brief Release a buffer back to the free list
@ -382,7 +382,7 @@ GDataBuffer *gfxBufferGetI(void);
*/ */
void gfxBufferRelease(GDataBuffer *pd); void gfxBufferRelease(GDataBuffer *pd);
void gfxBufferReleaseI(GDataBuffer *pd); void gfxBufferReleaseI(GDataBuffer *pd);
/* @} */ /** @} */
#ifdef __cplusplus #ifdef __cplusplus

9
src/gwin/button.c
View File

@ -7,12 +7,7 @@
/** /**
* @file src/gwin/button.c * @file src/gwin/button.c
* @brief GWIN sub-system button code. * @brief GWIN sub-system button code
*
* @defgroup Button Button
* @ingroup GWIN
*
* @{
*/ */
#include "gfx.h" #include "gfx.h"
@ -350,5 +345,3 @@ static const GColorSet *getDrawColors(GWidgetObject *gw) {
#endif #endif
#endif /* GFX_USE_GWIN && GWIN_NEED_BUTTON */ #endif /* GFX_USE_GWIN && GWIN_NEED_BUTTON */
/** @} */

2
src/gwin/button.h
View File

@ -10,7 +10,7 @@
* @brief GWIN Graphic window subsystem header file. * @brief GWIN Graphic window subsystem header file.
* *
* @defgroup Button Button * @defgroup Button Button
* @ingroup GWIN * @ingroup Widgets
* *
* @details GWIN allows it to easily create buttons with different styles * @details GWIN allows it to easily create buttons with different styles
* and check for different meta states such as: PRESSED, CLICKED, * and check for different meta states such as: PRESSED, CLICKED,

9
src/gwin/checkbox.c
View File

@ -7,12 +7,7 @@
/** /**
* @file src/gwin/checkbox.c * @file src/gwin/checkbox.c
* @brief GWIN sub-system button code. * @brief GWIN sub-system button code
*
* @defgroup Checkbox Checkbox
* @ingroup GWIN
*
* @{
*/ */
#include "gfx.h" #include "gfx.h"
@ -195,5 +190,3 @@ void gwinCheckboxDraw_CheckOnRight(GWidgetObject *gw, void *param) {
} }
#endif /* (GFX_USE_GWIN && GWIN_NEED_CHECKBOX) */ #endif /* (GFX_USE_GWIN && GWIN_NEED_CHECKBOX) */
/** @} */

4
src/gwin/checkbox.h
View File

@ -10,7 +10,7 @@
* @brief GWIN Graphic window subsystem header file. * @brief GWIN Graphic window subsystem header file.
* *
* @defgroup Checkbox Checkbox * @defgroup Checkbox Checkbox
* @ingroup GWIN * @ingroup Widgets
* *
* @details GWIN allows it to easily create a group of checkbox buttons. * @details GWIN allows it to easily create a group of checkbox buttons.
* *
@ -109,7 +109,7 @@ bool_t gwinCheckboxIsChecked(GHandle gh);
*/ */
void gwinCheckboxDraw_CheckOnLeft(GWidgetObject *gw, void *param); void gwinCheckboxDraw_CheckOnLeft(GWidgetObject *gw, void *param);
void gwinCheckboxDraw_CheckOnRight(GWidgetObject *gw, void *param); void gwinCheckboxDraw_CheckOnRight(GWidgetObject *gw, void *param);
/* @} */ /** @} */
#endif /* _GWIN_CHECKBOX_H */ #endif /* _GWIN_CHECKBOX_H */
/** @} */ /** @} */

14
src/gwin/class_gwin.h
View File

@ -5,7 +5,7 @@
* http://ugfx.org/license.html * http://ugfx.org/license.html
*/ */
/** /*
* @file src/gwin/class_gwin.h * @file src/gwin/class_gwin.h
* @brief GWIN Graphic window subsystem header file. * @brief GWIN Graphic window subsystem header file.
* *
@ -41,7 +41,7 @@
#define GWIN_FLG_MINIMIZED 0x00100000 // @< The window is minimized #define GWIN_FLG_MINIMIZED 0x00100000 // @< The window is minimized
#define GWIN_FLG_MAXIMIZED 0x00200000 // @< The window is maximized #define GWIN_FLG_MAXIMIZED 0x00200000 // @< The window is maximized
#define GWIN_FIRST_WM_FLAG 0x01000000 // @< 8 bits free for the window manager to use #define GWIN_FIRST_WM_FLAG 0x01000000 // @< 8 bits free for the window manager to use
/* @} */ /** @} */
/** /**
* @brief The Virtual Method Table for a GWIN window * @brief The Virtual Method Table for a GWIN window
@ -54,7 +54,7 @@ typedef struct gwinVMT {
void (*Redraw) (GWindowObject *gh); // @< The GWIN redraw routine (optional) void (*Redraw) (GWindowObject *gh); // @< The GWIN redraw routine (optional)
void (*AfterClear) (GWindowObject *gh); // @< The GWIN after-clear function (optional) void (*AfterClear) (GWindowObject *gh); // @< The GWIN after-clear function (optional)
} gwinVMT; } gwinVMT;
/* @} */ /** @} */
#if GWIN_NEED_WIDGET || defined(__DOXYGEN__) #if GWIN_NEED_WIDGET || defined(__DOXYGEN__)
@ -105,7 +105,7 @@ typedef struct gwinVMT {
}; };
#endif #endif
} gwidgetVMT; } gwidgetVMT;
/* @} */ /** @} */
#endif #endif
#if GWIN_NEED_CONTAINERS || defined(__DOXYGEN__) #if GWIN_NEED_CONTAINERS || defined(__DOXYGEN__)
@ -128,7 +128,7 @@ typedef struct gwinVMT {
void (*NotifyAdd) (GHandle gh, GHandle ghChild); // @< Notification that a child has been added (optional) void (*NotifyAdd) (GHandle gh, GHandle ghChild); // @< Notification that a child has been added (optional)
void (*NotifyDelete) (GHandle gh, GHandle ghChild); // @< Notification that a child has been deleted (optional) void (*NotifyDelete) (GHandle gh, GHandle ghChild); // @< Notification that a child has been deleted (optional)
} gcontainerVMT; } gcontainerVMT;
/* @} */ /** @} */
#endif #endif
// These flags are needed whether or not we are running a window manager. // These flags are needed whether or not we are running a window manager.
@ -140,7 +140,7 @@ typedef struct gwinVMT {
#define GWIN_WMFLG_NOBGCLEAR 0x0002 // @< Don't clear the area if the window is not visible #define GWIN_WMFLG_NOBGCLEAR 0x0002 // @< Don't clear the area if the window is not visible
#define GWIN_WMFLG_KEEPCLIP 0x0004 // @< Don't modify the preset clipping area #define GWIN_WMFLG_KEEPCLIP 0x0004 // @< Don't modify the preset clipping area
#define GWIN_WMFLG_NOZORDER 0x0008 // @< Don't redraw higher z-order windows that overlap #define GWIN_WMFLG_NOZORDER 0x0008 // @< Don't redraw higher z-order windows that overlap
/* @} */ /** @} */
#if GWIN_NEED_WINDOWMANAGER || defined(__DOXYGEN__) #if GWIN_NEED_WINDOWMANAGER || defined(__DOXYGEN__)
// @note There is only ever one instance of each GWindowManager type // @note There is only ever one instance of each GWindowManager type
@ -163,7 +163,7 @@ typedef struct gwinVMT {
void (*Raise) (GHandle gh); // @< A window wants to be on top void (*Raise) (GHandle gh); // @< A window wants to be on top
void (*MinMax) (GHandle gh, GWindowMinMax minmax); // @< A window wants to be minimized/maximised void (*MinMax) (GHandle gh, GWindowMinMax minmax); // @< A window wants to be minimized/maximised
} gwmVMT; } gwmVMT;
/* @} */ /** @} */
/** /**
* @brief The current window manager * @brief The current window manager

2
src/gwin/console.h
View File

@ -10,7 +10,7 @@
* @brief GWIN Graphic window subsystem header file. * @brief GWIN Graphic window subsystem header file.
* *
* @defgroup Console Console * @defgroup Console Console
* @ingroup GWIN * @ingroup Windows
* *
* @details GWIN allows it to create a console/terminal like window. * @details GWIN allows it to create a console/terminal like window.
* You can simply use chprintf() to print to the terminal. * You can simply use chprintf() to print to the terminal.

7
src/gwin/frame.c
View File

@ -8,11 +8,6 @@
/** /**
* @file src/gwin/frame.c * @file src/gwin/frame.c
* @brief GWIN sub-system frame code. * @brief GWIN sub-system frame code.
*
* @defgroup Frame Frame
* @ingroup GWIN
*
* @{
*/ */
#include "gfx.h" #include "gfx.h"
@ -229,5 +224,3 @@ static void gwinFrameDraw_Std(GWidgetObject *gw, void *param) {
} }
#endif /* (GFX_USE_GWIN && GWIN_NEED_FRAME) || defined(__DOXYGEN__) */ #endif /* (GFX_USE_GWIN && GWIN_NEED_FRAME) || defined(__DOXYGEN__) */
/** @} */

4
src/gwin/frame.h
View File

@ -10,7 +10,7 @@
* @brief GWIN Graphic window subsystem header file. * @brief GWIN Graphic window subsystem header file.
* *
* @defgroup Frame Frame * @defgroup Frame Frame
* @ingroup GWIN * @ingroup Containers
* *
* @details A frame is a rectangular window that can have optional border as well as buttons to * @details A frame is a rectangular window that can have optional border as well as buttons to
* close, maximize and minimize it. The main purpose of this widget is to contain children. * close, maximize and minimize it. The main purpose of this widget is to contain children.
@ -30,7 +30,7 @@
#define GWIN_FRAME_BORDER 0x00000001 #define GWIN_FRAME_BORDER 0x00000001
#define GWIN_FRAME_CLOSE_BTN 0x00000002 #define GWIN_FRAME_CLOSE_BTN 0x00000002
#define GWIN_FRAME_MINMAX_BTN 0x00000004 #define GWIN_FRAME_MINMAX_BTN 0x00000004
/* @} */ /** @} */
typedef struct GFrameObject { typedef struct GFrameObject {
GContainerObject gc; GContainerObject gc;

8
src/gwin/gcontainer.c
View File

@ -7,12 +7,7 @@
/** /**
* @file src/gwin/gcontainer.c * @file src/gwin/gcontainer.c
* @brief GWIN sub-system container code. * @brief GWIN sub-system container code
*
* @defgroup Containers Containers
* @ingroup GWIN
*
* @{
*/ */
#include "gfx.h" #include "gfx.h"
@ -190,4 +185,3 @@ GHandle gwinGContainerCreate(GDisplay *g, GContainerObject *gc, const GWidgetIni
} }
#endif #endif
/** @} */

23
src/gwin/gcontainer.h
View File

@ -7,17 +7,9 @@
/** /**
* @file src/gwin/gcontainer.h * @file src/gwin/gcontainer.h
* @brief GWIN Containers header file. *
*/ * @defgroup Container Container
* @ingroup Containers
#ifndef _GCONTAINER_H
#define _GCONTAINER_H
/* This file is included within "gwin/gwin.h" */
/**
* @defgroup Containers Containers
* @ingroup GWIN
* *
* @details A Container is a GWindow that supports child windows. It is also * @details A Container is a GWindow that supports child windows. It is also
* a widget in its own right and therefore can accept user input directly. * a widget in its own right and therefore can accept user input directly.
@ -26,6 +18,11 @@
* @{ * @{
*/ */
#ifndef _GCONTAINER_H
#define _GCONTAINER_H
/* This file is included within "gwin/gwin.h" */
// Forward definition // Forward definition
struct GContainerObject; struct GContainerObject;
@ -37,7 +34,7 @@ struct GContainerObject;
* @{ * @{
*/ */
typedef GWidgetObject GContainerObject; typedef GWidgetObject GContainerObject;
/* @} */ /** @} */
/** /**
* A comment/rant on the above structure: * A comment/rant on the above structure:
@ -108,7 +105,7 @@ extern "C" {
* @{ * @{
*/ */
#define GWIN_CONTAINER_BORDER 0x00000001 #define GWIN_CONTAINER_BORDER 0x00000001
/* @} */ /** @} */
/** /**
* @brief Create a simple container. * @brief Create a simple container.

3
src/gwin/gimage.c
View File

@ -7,7 +7,7 @@
/** /**
* @file src/gwin/gimage.c * @file src/gwin/gimage.c
* @brief GWIN sub-system image code. * @brief GWIN sub-system image code
*/ */
#include "gfx.h" #include "gfx.h"
@ -181,4 +181,3 @@ gdispImageError gwinImageCache(GHandle gh) {
} }
#endif // GFX_USE_GWIN && GWIN_NEED_IMAGE #endif // GFX_USE_GWIN && GWIN_NEED_IMAGE
/** @} */

2
src/gwin/gimage.h
View File

@ -10,7 +10,7 @@
* @brief GWIN image widget header file. * @brief GWIN image widget header file.
* *
* @defgroup Image Image * @defgroup Image Image
* @ingroup GWIN * @ingroup Widgets
* *
* @details GWIN allos it to create an image widget. The widget * @details GWIN allos it to create an image widget. The widget
* takes no user input. * takes no user input.

2
src/gwin/graph.c
View File

@ -7,7 +7,7 @@
/** /**
* @file src/gwin/graph.c * @file src/gwin/graph.c
* @brief GWIN sub-system button code. * @brief GWIN sub-system button code
*/ */
#include "gfx.h" #include "gfx.h"

6
src/gwin/graph.h
View File

@ -7,12 +7,12 @@
/** /**
* @file src/gwin/graph.h * @file src/gwin/graph.h
* @brief GWIN GRAPH module header file. * @brief GWIN GRAPH module header file
* *
* @defgroup Graph Graph * @defgroup Graph Graph
* @ingroup GWIN * @ingroup Windows
* *
* @details GWIN allows it to easily draw graphs. * @details GWIN allows it to easily draw graphs
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h * @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
* @pre GWIN_NEED_GRAPH must be set to TRUE in your gfxconf.h * @pre GWIN_NEED_GRAPH must be set to TRUE in your gfxconf.h
* *

30
src/gwin/gwidget.h
View File

@ -8,18 +8,11 @@
/** /**
* @file src/gwin/gwidget.h * @file src/gwin/gwidget.h
* @brief GWIN Widgets header file. * @brief GWIN Widgets header file.
*/
#ifndef _GWIDGET_H
#define _GWIDGET_H
/* This file is included within "gwin/gwin.h" */
/**
* @defgroup Widget Widget
* @ingroup GWIN
* *
* @details A Widget is a GWindow that supports interacting with the user * @defgroup Widget Widget
* @ingroup Widgets
*
* @details A widget is a Window that supports interacting with the user
* via an input device such as a mouse or toggle buttons. It is the * via an input device such as a mouse or toggle buttons. It is the
* base class for widgets such as buttons and sliders. * base class for widgets such as buttons and sliders.
* *
@ -27,6 +20,11 @@
* @{ * @{
*/ */
#ifndef _GWIDGET_H
#define _GWIDGET_H
/* This file is included within "gwin/gwin.h" */
// Forward definition // Forward definition
struct GWidgetObject; struct GWidgetObject;
@ -40,7 +38,7 @@ typedef struct GColorSet {
color_t fill; // @< The fill color color_t fill; // @< The fill color
color_t progress; // @< The color of progress bars color_t progress; // @< The color of progress bars
} GColorSet; } GColorSet;
/* @} */ /** @} */
/** /**
* @brief The GWidgetStyle structure * @brief The GWidgetStyle structure
@ -55,7 +53,7 @@ typedef struct GWidgetStyle {
GColorSet disabled; // @< The colors when disabled GColorSet disabled; // @< The colors when disabled
GColorSet pressed; // @< The colors when pressed GColorSet pressed; // @< The colors when pressed
} GWidgetStyle; } GWidgetStyle;
/* @} */ /** @} */
/** /**
* @brief We define a couple of GWidgetStyle's that you can use in your * @brief We define a couple of GWidgetStyle's that you can use in your
@ -67,7 +65,7 @@ typedef struct GWidgetStyle {
*/ */
extern const GWidgetStyle BlackWidgetStyle; extern const GWidgetStyle BlackWidgetStyle;
extern const GWidgetStyle WhiteWidgetStyle; extern const GWidgetStyle WhiteWidgetStyle;
/* @} */ /** @} */
/** /**
* @brief Defines a custom drawing function for a widget * @brief Defines a custom drawing function for a widget
@ -95,7 +93,7 @@ typedef struct GWidgetInit {
void * customParam; // @< A parameter for the custom draw function (default = NULL) void * customParam; // @< A parameter for the custom draw function (default = NULL)
const GWidgetStyle * customStyle; // @< A custom style to use - use NULL for the default style const GWidgetStyle * customStyle; // @< A custom style to use - use NULL for the default style
} GWidgetInit; } GWidgetInit;
/* @} */ /** @} */
/** /**
* @brief The GWIN Widget structure * @brief The GWIN Widget structure
@ -113,7 +111,7 @@ typedef struct GWidgetObject {
void * fnParam; // @< A parameter for the current draw function void * fnParam; // @< A parameter for the current draw function
const GWidgetStyle * pstyle; // @< The current widget style colors const GWidgetStyle * pstyle; // @< The current widget style colors
} GWidgetObject; } GWidgetObject;
/* @} */ /** @} */
/** /**
* A comment/rant on the above structure: * A comment/rant on the above structure:

9
src/gwin/label.c
View File

@ -7,12 +7,7 @@
/** /**
* @file src/gwin/label.c * @file src/gwin/label.c
* @brief GWIN label widget header file. * @brief GWIN label widget header file
*
* @defgroup Label Label
* @ingroup GWIN
*
* @{
*/ */
#include "gfx.h" #include "gfx.h"
@ -171,5 +166,3 @@ static void gwinLabelDefaultDraw(GWidgetObject *gw, void *param) {
} }
#endif // GFX_USE_GWIN && GFX_NEED_LABEL #endif // GFX_USE_GWIN && GFX_NEED_LABEL
/** @} */

4
src/gwin/label.h
View File

@ -7,10 +7,10 @@
/** /**
* @file src/gwin/label.h * @file src/gwin/label.h
* @brief GWIN label widget header file. * @brief GWIN label widget header file
* *
* @defgroup Label Label * @defgroup Label Label
* @ingroup GWIN * @ingroup Widgets
* *
* @details GWIN allos it to create an label widget. The widget * @details GWIN allos it to create an label widget. The widget
* takes no user input. * takes no user input.

9
src/gwin/list.c
View File

@ -7,12 +7,7 @@
/** /**
* @file src/gwin/list.c * @file src/gwin/list.c
* @brief GWIN list widget header file. * @brief GWIN list widget header file
*
* @defgroup List List
* @ingroup GWIN
*
* @{
*/ */
#include "gfx.h" #include "gfx.h"
@ -696,5 +691,3 @@ static void gwinListDefaultDraw(GWidgetObject* gw, void* param) {
} }
#endif // GFX_USE_GWIN && GWIN_NEED_LIST #endif // GFX_USE_GWIN && GWIN_NEED_LIST
/** @} */

2
src/gwin/list.h
View File

@ -10,7 +10,7 @@
* @brief GWIN list widget header file * @brief GWIN list widget header file
* *
* @defgroup List List * @defgroup List List
* @ingroup GWIN * @ingroup Widgets
* *
* @details GWIN allows it to create a list widget. * @details GWIN allows it to create a list widget.
* *

9
src/gwin/progressbar.c
View File

@ -7,12 +7,7 @@
/** /**
* @file src/gwin/progressbar.c * @file src/gwin/progressbar.c
* @brief GWIN sub-system progressbar code. * @brief GWIN sub-system progressbar code
*
* @defgroup Progressbar Progressbar
* @ingroup GWIN
*
* @{
*/ */
#include "gfx.h" #include "gfx.h"
@ -319,5 +314,3 @@ void gwinProgressbarDraw_Image(GWidgetObject *gw, void *param) {
#endif /* GDISP_NEED_IMAGE */ #endif /* GDISP_NEED_IMAGE */
#endif /* GFX_USE_GWIN && GWIN_NEED_BUTTON */ #endif /* GFX_USE_GWIN && GWIN_NEED_BUTTON */
/** @} */

5
src/gwin/progressbar.h
View File

@ -10,7 +10,7 @@
* @brief GWIN Graphic window subsystem header file. * @brief GWIN Graphic window subsystem header file.
* *
* @defgroup Progressbar Progressbar * @defgroup Progressbar Progressbar
* @ingroup GWIN * @ingroup Widgets
* *
* @details Create progressbars with different styles * @details Create progressbars with different styles
* *
@ -199,7 +199,7 @@ void gwinProgressbarDecrement(GHandle gh);
*/ */
void gwinProgressbarDraw_Std(GWidgetObject *gw, void *param); void gwinProgressbarDraw_Std(GWidgetObject *gw, void *param);
void gwinProgressbarDraw_Image(GWidgetObject *gw, void *param); void gwinProgressbarDraw_Image(GWidgetObject *gw, void *param);
/* @} */ /** @} */
#ifdef __cplusplus #ifdef __cplusplus
} }
@ -207,4 +207,3 @@ void gwinProgressbarDraw_Image(GWidgetObject *gw, void *param);
#endif /* _GWIN_PROGRESSBAR_H */ #endif /* _GWIN_PROGRESSBAR_H */
/** @} */ /** @} */

9
src/gwin/radio.c
View File

@ -7,12 +7,7 @@
/** /**
* @file src/gwin/radio.c * @file src/gwin/radio.c
* @brief GWIN sub-system radio button code. * @brief GWIN sub-system radio button code
*
* @defgroup RadioButton RadioButton
* @ingroup GWIN
*
* @{
*/ */
#include "gfx.h" #include "gfx.h"
@ -280,5 +275,3 @@ void gwinRadioDraw_Radio(GWidgetObject *gw, void *param) {
#endif #endif
#endif /* GFX_USE_GWIN && GWIN_NEED_BUTTON */ #endif /* GFX_USE_GWIN && GWIN_NEED_BUTTON */
/** @} */

3
src/gwin/radio.h
View File

@ -10,7 +10,7 @@
* @brief GWIN Graphic window subsystem header file. * @brief GWIN Graphic window subsystem header file.
* *
* @defgroup RadioButton RadioButton * @defgroup RadioButton RadioButton
* @ingroup GWIN * @ingroup Widgets
* *
* @details GWIN allows it to easily create radio buttons with different styles. * @details GWIN allows it to easily create radio buttons with different styles.
* *
@ -139,4 +139,3 @@ void gwinRadioDraw_Tab(GWidgetObject *gw, void *param); // @< Draw as a tab
#endif /* _GWIN_RADIO_H */ #endif /* _GWIN_RADIO_H */
/** @} */ /** @} */

9
src/gwin/slider.c
View File

@ -7,12 +7,7 @@
/** /**
* @file src/gwin/slider.c * @file src/gwin/slider.c
* @brief GWIN sub-system slider code. * @brief GWIN sub-system slider code
*
* @defgroup Slider Slider
* @ingroup GWIN
*
* @{
*/ */
#include "gfx.h" #include "gfx.h"
@ -376,5 +371,3 @@ void gwinSliderDraw_Image(GWidgetObject *gw, void *param) {
#endif /* GDISP_NEED_IMAGE */ #endif /* GDISP_NEED_IMAGE */
#endif /* GFX_USE_GWIN && GWIN_NEED_BUTTON */ #endif /* GFX_USE_GWIN && GWIN_NEED_BUTTON */
/** @} */

5
src/gwin/slider.h
View File

@ -10,7 +10,7 @@
* @brief GWIN Graphic window subsystem header file. * @brief GWIN Graphic window subsystem header file.
* *
* @defgroup Slider Slider * @defgroup Slider Slider
* @ingroup GWIN * @ingroup Widgets
* *
* @details Create sliders with different styles * @details Create sliders with different styles
* *
@ -144,7 +144,7 @@ void gwinSliderSetPosition(GHandle gh, int pos);
*/ */
void gwinSliderDraw_Std(GWidgetObject *gw, void *param); void gwinSliderDraw_Std(GWidgetObject *gw, void *param);
void gwinSliderDraw_Image(GWidgetObject *gw, void *param); void gwinSliderDraw_Image(GWidgetObject *gw, void *param);
/* @} */ /** @} */
#ifdef __cplusplus #ifdef __cplusplus
} }
@ -152,4 +152,3 @@ void gwinSliderDraw_Image(GWidgetObject *gw, void *param);
#endif /* _GWIN_SLIDER_H */ #endif /* _GWIN_SLIDER_H */
/** @} */ /** @} */

6
src/gwin/sys_defs.h
View File

@ -9,7 +9,7 @@
* @file src/gwin/sys_defs.h * @file src/gwin/sys_defs.h
* *
* @defgroup Window Window * @defgroup Window Window
* @ingroup GWIN * @ingroup Windows
* *
* @details GWIN provides a basic window manager which allows it to easily * @details GWIN provides a basic window manager which allows it to easily
* create and destroy different windows at runtime. Each window * create and destroy different windows at runtime. Each window
@ -53,7 +53,7 @@ typedef struct GWindowObject {
GHandle parent; // @< The parent window GHandle parent; // @< The parent window
#endif #endif
} GWindowObject, * GHandle; } GWindowObject, * GHandle;
/* @} */ /** @} */
/** /**
* @brief The structure to initialise a GWIN. * @brief The structure to initialise a GWIN.
@ -75,7 +75,7 @@ typedef struct GWindowInit {
GHandle parent; // @< The parent - must be a container or NULL GHandle parent; // @< The parent - must be a container or NULL
#endif #endif
} GWindowInit; } GWindowInit;
/* @} */ /** @} */
/** /**
* @brief A window's minimized, maximized or normal size * @brief A window's minimized, maximized or normal size

3
src/gwin/sys_options.h
View File

@ -10,7 +10,8 @@
* @brief GWIN sub-system options header file. * @brief GWIN sub-system options header file.
* *
* @addtogroup GWIN * @addtogroup GWIN
* @brief Module which provides a complete GUI toolkit based on widgets * @brief The GWIN module uses all the other modules (GDISP, GINPUT, GTIMER...) to
* form a complete GUI toolkit.
* *
* @{ * @{
*/ */