Browse Source

doxygen fixes

remotes/origin_old/ugfx_release_2.6
Joel Bodenmann 9 years ago
parent
commit
e9179545af
  1. 6
      src/gadc/driver.h
  2. 2
      src/gadc/sys_defs.h
  3. 2
      src/gaudio/driver_play.h
  4. 11
      src/gaudio/sys_defs.h
  5. 2
      src/gdisp/colors.h
  6. 2
      src/gdisp/image.h
  7. 2
      src/ginput/dial.h
  8. 2
      src/ginput/keyboard.h
  9. 2
      src/ginput/mouse.h
  10. 2
      src/ginput/toggle.h
  11. 2
      src/gos/chibios.h
  12. 2
      src/gos/linux.h
  13. 2
      src/gos/osx.h
  14. 2
      src/gos/raw32.h
  15. 1
      src/gos/sys_defs.h
  16. 2
      src/gos/win32.h
  17. 4
      src/gqueue/sys_defs.h
  18. 2
      src/gwin/button.h
  19. 2
      src/gwin/checkbox.h
  20. 2
      src/gwin/class_gwin.h
  21. 2
      src/gwin/console.h
  22. 2
      src/gwin/graph.h
  23. 2
      src/gwin/gwidget.h
  24. 2
      src/gwin/image.h
  25. 2
      src/gwin/label.c
  26. 2
      src/gwin/label.h
  27. 2
      src/gwin/list.c
  28. 2
      src/gwin/list.h
  29. 2
      src/gwin/progressbar.h
  30. 2
      src/gwin/radio.h
  31. 2
      src/gwin/slider.h
  32. 2
      src/gwin/sys_defs.h
  33. 2
      src/gwin/sys_options.h

6
src/gadc/driver.h

@ -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
*/

2
src/gadc/sys_defs.h

@ -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().

2
src/gaudio/driver_play.h

@ -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.

11
src/gaudio/sys_defs.h

@ -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);

2
src/gdisp/colors.h

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

2
src/gdisp/image.h

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

2
src/ginput/dial.h

@ -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

2
src/ginput/keyboard.h

@ -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

2
src/ginput/mouse.h

@ -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

2
src/ginput/toggle.h

@ -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

2
src/gos/chibios.h

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

2
src/gos/linux.h

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

2
src/gos/osx.h

@ -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.
*/

2
src/gos/raw32.h

@ -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
*/

1
src/gos/sys_defs.h

@ -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

2
src/gos/win32.h

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

4
src/gqueue/sys_defs.h

@ -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
* @{

2
src/gwin/button.h

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

2
src/gwin/checkbox.h

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

2
src/gwin/class_gwin.h

@ -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

2
src/gwin/console.h

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

2
src/gwin/graph.h

@ -6,7 +6,7 @@
*/
/**
* @file include/gwin/graph.h
* @file src/gwin/graph.h
* @brief GWIN GRAPH module header file.
*
* @defgroup Graph Graph

2
src/gwin/gwidget.h

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

2
src/gwin/image.h

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

2
src/gwin/label.c

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

2
src/gwin/label.h

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

2
src/gwin/list.c

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

2
src/gwin/list.h

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

2
src/gwin/progressbar.h

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

2
src/gwin/radio.h

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

2
src/gwin/slider.h

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

2
src/gwin/sys_defs.h

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

2
src/gwin/sys_options.h

@ -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…
Cancel
Save