doxygen fixes
Joel Bodenmann
parent
08e1b0ebc7
commit
e9179545af
|
|
@ -89,6 +89,8 @@ void gadc_lld_init(void);
|
|||
*
|
||||
* @param[in] physdev The hardware dependent physical device descriptor
|
||||
*
|
||||
* @return ToDo
|
||||
*
|
||||
* @api
|
||||
*/
|
||||
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
|
||||
* a new job.
|
||||
*
|
||||
* @param[in] pjob ToDo
|
||||
*
|
||||
* @api
|
||||
* @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.
|
||||
*
|
||||
* @param[in] pjob ToDo
|
||||
*
|
||||
* @api
|
||||
* @iclass
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -164,7 +164,7 @@ void gadcHighSpeedSetISRCallback(GADCISRCallbackFunction isrfn);
|
|||
* @brief Get a filled buffer from the ADC
|
||||
* @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
|
||||
* it can be used again. This can be done using @p gfxBufferRelease().
|
||||
|
|
|
|||
|
|
@ -107,7 +107,7 @@ void gaudio_play_lld_stop(void);
|
|||
* @brief Set the output volume.
|
||||
* @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 For stereo devices, both channels are set to the same volume.
|
||||
|
|
|
|||
|
|
@ -161,7 +161,7 @@ extern "C" {
|
|||
* @brief Set the output volume.
|
||||
* @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 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
|
||||
* @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
|
||||
*/
|
||||
|
|
@ -252,7 +254,7 @@ extern "C" {
|
|||
* @brief Get a filled audio buffer from the recording list
|
||||
* @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
|
||||
* 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
|
||||
* 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.
|
||||
*
|
||||
* @return ToDo
|
||||
*
|
||||
* @api
|
||||
*/
|
||||
GDataBuffer *gaudioRecordGetData(delaytime_t ms);
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gdisp/colors.h
|
||||
* @file src/gdisp/colors.h
|
||||
* @brief GDISP color definitions header file.
|
||||
*
|
||||
* @defgroup Colors Colors
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gdisp/image.h
|
||||
* @file src/gdisp/image.h
|
||||
* @brief GDISP image header file.
|
||||
*
|
||||
* @defgroup Image Image
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/ginput/dial.h
|
||||
* @file src/ginput/dial.h
|
||||
* @brief GINPUT GFX User Input subsystem header file.
|
||||
*
|
||||
* @defgroup Dial Dial
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/ginput/keyboard.h
|
||||
* @file src/ginput/keyboard.h
|
||||
* @brief GINPUT GFX User Input subsystem header file.
|
||||
*
|
||||
* @defgroup Keyboard Keyboard
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*
|
||||
* @defgroup Mouse Mouse
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/ginput/toggle.h
|
||||
* @file src/ginput/toggle.h
|
||||
* @brief GINPUT GFX User Input subsystem header file.
|
||||
*
|
||||
* @defgroup Toggle Toggle
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gos/chibios.h
|
||||
* @file src/gos/chibios.h
|
||||
* @brief GOS - Operating System Support header file for ChibiOS.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gos/linux.h
|
||||
* @file src/gos/linux.h
|
||||
* @brief GOS - Operating System Support header file for LINUX.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -333,7 +333,6 @@
|
|||
* @return FALSE if the wait would occur occurred otherwise TRUE
|
||||
*
|
||||
* @param[in] psem A pointer to the semaphore
|
||||
* @param[in] ms The maximum time to wait for the semaphore
|
||||
*
|
||||
* @iclass
|
||||
* @api
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gos/win32.h
|
||||
* @file src/gos/win32.h
|
||||
* @brief GOS - Operating System Support header file for WIN32.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -333,7 +333,9 @@ bool_t gfxBufferIsAvailable(void);
|
|||
* @brief Get a buffer from the free list
|
||||
* @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
|
||||
* @{
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/button.h
|
||||
* @file src/gwin/button.h
|
||||
* @brief GWIN Graphic window subsystem header file.
|
||||
*
|
||||
* @defgroup Button Button
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/checkbox.h
|
||||
* @file src/gwin/checkbox.h
|
||||
* @brief GWIN Graphic window subsystem header file.
|
||||
*
|
||||
* @defgroup Checkbox Checkbox
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/class_gwin.h
|
||||
* @file src/gwin/class_gwin.h
|
||||
* @brief GWIN Graphic window subsystem header file.
|
||||
*
|
||||
* @defgroup Internal Internal
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/console.h
|
||||
* @file src/gwin/console.h
|
||||
* @brief GWIN Graphic window subsystem header file.
|
||||
*
|
||||
* @defgroup Console Console
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/graph.h
|
||||
* @file src/gwin/graph.h
|
||||
* @brief GWIN GRAPH module header file.
|
||||
*
|
||||
* @defgroup Graph Graph
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/gwidget.h
|
||||
* @file src/gwin/gwidget.h
|
||||
* @brief GWIN Widgets header file.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/image.h
|
||||
* @file src/gwin/image.h
|
||||
* @brief GWIN image widget header file.
|
||||
*
|
||||
* @defgroup Image Image
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/label.h
|
||||
* @file src/gwin/label.c
|
||||
* @brief GWIN label widget header file.
|
||||
*
|
||||
* @defgroup Label Label
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/label.h
|
||||
* @file src/gwin/label.h
|
||||
* @brief GWIN label widget header file.
|
||||
*
|
||||
* @defgroup Label Label
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/list.h
|
||||
* @file src/gwin/list.c
|
||||
* @brief GWIN list widget header file.
|
||||
*
|
||||
* @defgroup List List
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/list.h
|
||||
* @file src/gwin/list.h
|
||||
* @brief GWIN list widget header file
|
||||
*
|
||||
* @defgroup List List
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/progressbar.h
|
||||
* @file src/gwin/progressbar.h
|
||||
* @brief GWIN Graphic window subsystem header file.
|
||||
*
|
||||
* @defgroup Progressbar Progressbar
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/radio.h
|
||||
* @file src/gwin/radio.h
|
||||
* @brief GWIN Graphic window subsystem header file.
|
||||
*
|
||||
* @defgroup RadioButton RadioButton
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/slider.h
|
||||
* @file src/gwin/slider.h
|
||||
* @brief GWIN Graphic window subsystem header file.
|
||||
*
|
||||
* @defgroup Slider Slider
|
||||
|
|
|
|||
|
|
@ -439,6 +439,8 @@ extern "C" {
|
|||
*
|
||||
* @param[in] gh The window
|
||||
*
|
||||
* @return ToDo
|
||||
*
|
||||
* @api
|
||||
*/
|
||||
GWindowMinMax gwinGetMinMax(GHandle gh);
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file include/gwin/sys_options.h
|
||||
* @file src/gwin/sys_options.h
|
||||
* @brief GWIN sub-system options header file.
|
||||
*
|
||||
* @addtogroup GWIN
|
||||
|
|
|
|||
Loading…
Reference in New Issue