diff options
| author | Joel Bodenmann <joel@unormal.org> | 2013-07-21 22:02:57 +0200 |
|---|---|---|
| committer | Joel Bodenmann <joel@unormal.org> | 2013-07-21 22:02:57 +0200 |
| commit | a6758342668712563bd4058160e6f5dc5636ba18 (patch) | |
| tree | abc0e43082010eecd332d0fc2c9eb4881eb01801 /include/gqueue/gqueue.h | |
| parent | d98e6c5d0d6c048c99aeda810da10e6a6a130325 (diff) | |
| download | uGFX-a6758342668712563bd4058160e6f5dc5636ba18.tar.gz uGFX-a6758342668712563bd4058160e6f5dc5636ba18.tar.bz2 uGFX-a6758342668712563bd4058160e6f5dc5636ba18.zip | |
doxygen updates
Diffstat (limited to 'include/gqueue/gqueue.h')
| -rw-r--r-- | include/gqueue/gqueue.h | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/include/gqueue/gqueue.h b/include/gqueue/gqueue.h index 8ec3c9b9..68cfdc2f 100644 --- a/include/gqueue/gqueue.h +++ b/include/gqueue/gqueue.h @@ -10,7 +10,10 @@ * @brief GQUEUE header file. * * @addtogroup GQUEUE - * @brief GQUEUE provides queue management. There are 3 types of queues: + * + * @brief Module which provides queue management (only internally used) + * + * @details There are 3 types of queues: * <ul><li><b>Asynchronous Queues (ASync) </b> - Queue operations never block</li> * <li><b>Get Synchronous Queues (GSync) </b> - Queue Get operations block until something is placed in the Queue</li> * <li><b>Put Synchronous Queues (PSync)</b> - Queue Put operations block until the element is removed from the Queue</li> @@ -128,7 +131,7 @@ bool_t gfxQueueFSyncPut(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, delayti /** * @brief Pop an item from the head of the queue (and remove it from the queue). - * @detail This is exactly the same as the Get operation above. + * @details This is exactly the same as the Get operation above. * * @api * @{ |