doxygen fixes

ugfx_release_2.6
Joel Bodenmann 2014-03-28 20:18:03 +01:00
parent 08e1b0ebc7
commit e9179545af
33 changed files with 47 additions and 33 deletions

View File

@ -89,6 +89,8 @@ void gadc_lld_init(void);
* *
* @param[in] physdev The hardware dependent physical device descriptor * @param[in] physdev The hardware dependent physical device descriptor
* *
* @return ToDo
*
* @api * @api
*/ */
size_t gadc_lld_samplesperconversion(uint32_t physdev); size_t gadc_lld_samplesperconversion(uint32_t physdev);
@ -122,6 +124,8 @@ void gadc_lld_stop_timerI(void);
* @note This will only be called if the timer is currently running and the ADC should be ready for * @note This will only be called if the timer is currently running and the ADC should be ready for
* a new job. * a new job.
* *
* @param[in] pjob ToDo
*
* @api * @api
* @iclass * @iclass
*/ */
@ -132,6 +136,8 @@ void gadc_lld_timerjobI(GadcTimerJob *pjob);
* *
* @note This will only be called if the ADC should be ready for a new job. * @note This will only be called if the ADC should be ready for a new job.
* *
* @param[in] pjob ToDo
*
* @api * @api
* @iclass * @iclass
*/ */

View File

@ -164,7 +164,7 @@ void gadcHighSpeedSetISRCallback(GADCISRCallbackFunction isrfn);
* @brief Get a filled buffer from the ADC * @brief Get a filled buffer from the ADC
* @return A GDataBuffer pointer or NULL if the timeout is exceeded * @return A GDataBuffer pointer or NULL if the timeout is exceeded
* *
* @params[in] ms The maximum amount of time in milliseconds to wait for data if some is not currently available. * @param[in] ms The maximum amount of time in milliseconds to wait for data if some is not currently available.
* *
* @note After processing the data, your application must return the buffer to the free-list so that * @note After processing the data, your application must return the buffer to the free-list so that
* it can be used again. This can be done using @p gfxBufferRelease(). * it can be used again. This can be done using @p gfxBufferRelease().

View File

@ -107,7 +107,7 @@ void gaudio_play_lld_stop(void);
* @brief Set the output volume. * @brief Set the output volume.
* @return TRUE if successful. * @return TRUE if successful.
* *
* @param[in] 0->255 (0 = muted) * @param[in] vol 0->255 (0 = muted)
* *
* @note Some drivers may not support this. They will return FALSE. * @note Some drivers may not support this. They will return FALSE.
* @note For stereo devices, both channels are set to the same volume. * @note For stereo devices, both channels are set to the same volume.

View File

@ -161,7 +161,7 @@ extern "C" {
* @brief Set the output volume. * @brief Set the output volume.
* @return TRUE if successful. * @return TRUE if successful.
* *
* @param[in] 0->255 (0 = muted) * @param[in] vol 0->255 (0 = muted)
* *
* @note Some drivers may not support this. They will return FALSE. * @note Some drivers may not support this. They will return FALSE.
* @note For stereo devices, both channels are set to the same volume. * @note For stereo devices, both channels are set to the same volume.
@ -193,7 +193,9 @@ extern "C" {
* @brief Wait for any currently playing sounds to complete * @brief Wait for any currently playing sounds to complete
* @return TRUE if there is now nothing playing or FALSE if the timeout is exceeded * @return TRUE if there is now nothing playing or FALSE if the timeout is exceeded
* *
* @params[in] ms The maximum amount of time in milliseconds to wait for playing to complete. * @param[in] ms The maximum amount of time in milliseconds to wait for playing to complete.
*
* @return ToDo
* *
* @api * @api
*/ */
@ -252,7 +254,7 @@ extern "C" {
* @brief Get a filled audio buffer from the recording list * @brief Get a filled audio buffer from the recording list
* @return A GDataBuffer pointer or NULL if the timeout is exceeded * @return A GDataBuffer pointer or NULL if the timeout is exceeded
* *
* @params[in] ms The maximum amount of time in milliseconds to wait for data if some is not currently available. * @param[in] ms The maximum amount of time in milliseconds to wait for data if some is not currently available.
* *
* @note After processing the audio data, your application must return the buffer to the free-list so that * @note After processing the audio data, your application must return the buffer to the free-list so that
* it can be used to record more audio into. This can be done via the play list using @p gaudioPlay() or * it can be used to record more audio into. This can be done via the play list using @p gaudioPlay() or
@ -261,6 +263,9 @@ extern "C" {
* processing it before GADC re-uses it. This is useful when RAM usage is critical to reduce the number * processing it before GADC re-uses it. This is useful when RAM usage is critical to reduce the number
* of buffers required. It works before the free list is a FIFO queue and therefore buffers are kept * of buffers required. It works before the free list is a FIFO queue and therefore buffers are kept
* in the queue as long as possible before they are re-used. * in the queue as long as possible before they are re-used.
*
* @return ToDo
*
* @api * @api
*/ */
GDataBuffer *gaudioRecordGetData(delaytime_t ms); GDataBuffer *gaudioRecordGetData(delaytime_t ms);

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gdisp/colors.h * @file src/gdisp/colors.h
* @brief GDISP color definitions header file. * @brief GDISP color definitions header file.
* *
* @defgroup Colors Colors * @defgroup Colors Colors

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gdisp/image.h * @file src/gdisp/image.h
* @brief GDISP image header file. * @brief GDISP image header file.
* *
* @defgroup Image Image * @defgroup Image Image

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/ginput/dial.h * @file src/ginput/dial.h
* @brief GINPUT GFX User Input subsystem header file. * @brief GINPUT GFX User Input subsystem header file.
* *
* @defgroup Dial Dial * @defgroup Dial Dial

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/ginput/keyboard.h * @file src/ginput/keyboard.h
* @brief GINPUT GFX User Input subsystem header file. * @brief GINPUT GFX User Input subsystem header file.
* *
* @defgroup Keyboard Keyboard * @defgroup Keyboard Keyboard

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/ginput/mouse.h * @file src/ginput/mouse.h
* @brief GINPUT GFX User Input subsystem header file for mouse and touch. * @brief GINPUT GFX User Input subsystem header file for mouse and touch.
* *
* @defgroup Mouse Mouse * @defgroup Mouse Mouse

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/ginput/toggle.h * @file src/ginput/toggle.h
* @brief GINPUT GFX User Input subsystem header file. * @brief GINPUT GFX User Input subsystem header file.
* *
* @defgroup Toggle Toggle * @defgroup Toggle Toggle

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gos/chibios.h * @file src/gos/chibios.h
* @brief GOS - Operating System Support header file for ChibiOS. * @brief GOS - Operating System Support header file for ChibiOS.
*/ */

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gos/linux.h * @file src/gos/linux.h
* @brief GOS - Operating System Support header file for LINUX. * @brief GOS - Operating System Support header file for LINUX.
*/ */

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gos/osx.h * @file src/gos/osx.h
* @brief GOS - Operating System Support header file for Mac OS-X. * @brief GOS - Operating System Support header file for Mac OS-X.
*/ */

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gos/raw32.h * @file src/gos/raw32.h
* @brief GOS - Operating System Support header file for any 32 bit processor in bare-metal mode * @brief GOS - Operating System Support header file for any 32 bit processor in bare-metal mode
*/ */

View File

@ -333,7 +333,6 @@
* @return FALSE if the wait would occur occurred otherwise TRUE * @return FALSE if the wait would occur occurred otherwise TRUE
* *
* @param[in] psem A pointer to the semaphore * @param[in] psem A pointer to the semaphore
* @param[in] ms The maximum time to wait for the semaphore
* *
* @iclass * @iclass
* @api * @api

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gos/win32.h * @file src/gos/win32.h
* @brief GOS - Operating System Support header file for WIN32. * @brief GOS - Operating System Support header file for WIN32.
*/ */

View File

@ -333,7 +333,9 @@ bool_t gfxBufferIsAvailable(void);
* @brief Get a buffer from the free list * @brief Get a buffer from the free list
* @return A GDataBuffer pointer or NULL if the timeout is exceeded * @return A GDataBuffer pointer or NULL if the timeout is exceeded
* *
* @params[in] ms The maximum amount of time in milliseconds to wait for a buffer if one is not available. * @param[in] ms The maximum amount of time in milliseconds to wait for a buffer if one is not available.
*
* @return ToDo
* *
* @api * @api
* @{ * @{

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gwin/button.h * @file src/gwin/button.h
* @brief GWIN Graphic window subsystem header file. * @brief GWIN Graphic window subsystem header file.
* *
* @defgroup Button Button * @defgroup Button Button

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gwin/checkbox.h * @file src/gwin/checkbox.h
* @brief GWIN Graphic window subsystem header file. * @brief GWIN Graphic window subsystem header file.
* *
* @defgroup Checkbox Checkbox * @defgroup Checkbox Checkbox

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gwin/class_gwin.h * @file src/gwin/class_gwin.h
* @brief GWIN Graphic window subsystem header file. * @brief GWIN Graphic window subsystem header file.
* *
* @defgroup Internal Internal * @defgroup Internal Internal

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gwin/console.h * @file src/gwin/console.h
* @brief GWIN Graphic window subsystem header file. * @brief GWIN Graphic window subsystem header file.
* *
* @defgroup Console Console * @defgroup Console Console

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/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

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gwin/gwidget.h * @file src/gwin/gwidget.h
* @brief GWIN Widgets header file. * @brief GWIN Widgets header file.
*/ */

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gwin/image.h * @file src/gwin/image.h
* @brief GWIN image widget header file. * @brief GWIN image widget header file.
* *
* @defgroup Image Image * @defgroup Image Image

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gwin/label.h * @file src/gwin/label.c
* @brief GWIN label widget header file. * @brief GWIN label widget header file.
* *
* @defgroup Label Label * @defgroup Label Label

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/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

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gwin/list.h * @file src/gwin/list.c
* @brief GWIN list widget header file. * @brief GWIN list widget header file.
* *
* @defgroup List List * @defgroup List List

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gwin/list.h * @file src/gwin/list.h
* @brief GWIN list widget header file * @brief GWIN list widget header file
* *
* @defgroup List List * @defgroup List List

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gwin/progressbar.h * @file src/gwin/progressbar.h
* @brief GWIN Graphic window subsystem header file. * @brief GWIN Graphic window subsystem header file.
* *
* @defgroup Progressbar Progressbar * @defgroup Progressbar Progressbar

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gwin/radio.h * @file src/gwin/radio.h
* @brief GWIN Graphic window subsystem header file. * @brief GWIN Graphic window subsystem header file.
* *
* @defgroup RadioButton RadioButton * @defgroup RadioButton RadioButton

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gwin/slider.h * @file src/gwin/slider.h
* @brief GWIN Graphic window subsystem header file. * @brief GWIN Graphic window subsystem header file.
* *
* @defgroup Slider Slider * @defgroup Slider Slider

View File

@ -439,6 +439,8 @@ extern "C" {
* *
* @param[in] gh The window * @param[in] gh The window
* *
* @return ToDo
*
* @api * @api
*/ */
GWindowMinMax gwinGetMinMax(GHandle gh); GWindowMinMax gwinGetMinMax(GHandle gh);

View File

@ -6,7 +6,7 @@
*/ */
/** /**
* @file include/gwin/sys_options.h * @file src/gwin/sys_options.h
* @brief GWIN sub-system options header file. * @brief GWIN sub-system options header file.
* *
* @addtogroup GWIN * @addtogroup GWIN