aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoel Bodenmann <joel@unormal.org>2014-03-28 20:18:03 +0100
committerJoel Bodenmann <joel@unormal.org>2014-03-28 20:18:03 +0100
commite9179545afc320e2404d1e2397c50cc71987bd10 (patch)
tree0e6fe26dadbaefb817812510c211b01c65d018c2
parent08e1b0ebc7a5b9a960994e16710465dfb67f66ee (diff)
downloaduGFX-e9179545afc320e2404d1e2397c50cc71987bd10.tar.gz
uGFX-e9179545afc320e2404d1e2397c50cc71987bd10.tar.bz2
uGFX-e9179545afc320e2404d1e2397c50cc71987bd10.zip
doxygen fixes
-rw-r--r--src/gadc/driver.h6
-rw-r--r--src/gadc/sys_defs.h2
-rw-r--r--src/gaudio/driver_play.h2
-rw-r--r--src/gaudio/sys_defs.h11
-rw-r--r--src/gdisp/colors.h2
-rw-r--r--src/gdisp/image.h2
-rw-r--r--src/ginput/dial.h2
-rw-r--r--src/ginput/keyboard.h2
-rw-r--r--src/ginput/mouse.h2
-rw-r--r--src/ginput/toggle.h2
-rw-r--r--src/gos/chibios.h2
-rw-r--r--src/gos/linux.h2
-rw-r--r--src/gos/osx.h2
-rw-r--r--src/gos/raw32.h2
-rw-r--r--src/gos/sys_defs.h1
-rw-r--r--src/gos/win32.h2
-rw-r--r--src/gqueue/sys_defs.h4
-rw-r--r--src/gwin/button.h2
-rw-r--r--src/gwin/checkbox.h2
-rw-r--r--src/gwin/class_gwin.h2
-rw-r--r--src/gwin/console.h2
-rw-r--r--src/gwin/graph.h2
-rw-r--r--src/gwin/gwidget.h2
-rw-r--r--src/gwin/image.h2
-rw-r--r--src/gwin/label.c2
-rw-r--r--src/gwin/label.h2
-rw-r--r--src/gwin/list.c2
-rw-r--r--src/gwin/list.h2
-rw-r--r--src/gwin/progressbar.h2
-rw-r--r--src/gwin/radio.h2
-rw-r--r--src/gwin/slider.h2
-rw-r--r--src/gwin/sys_defs.h2
-rw-r--r--src/gwin/sys_options.h2
33 files changed, 47 insertions, 33 deletions
diff --git a/src/gadc/driver.h b/src/gadc/driver.h
index 4145bc4a..450abbd3 100644
--- a/src/gadc/driver.h
+++ b/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
*/
diff --git a/src/gadc/sys_defs.h b/src/gadc/sys_defs.h
index 035fa9ad..b1d1ba1c 100644
--- a/src/gadc/sys_defs.h
+++ b/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().
diff --git a/src/gaudio/driver_play.h b/src/gaudio/driver_play.h
index d140c2c9..343a0fed 100644
--- a/src/gaudio/driver_play.h
+++ b/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.
diff --git a/src/gaudio/sys_defs.h b/src/gaudio/sys_defs.h
index 2bd0e2c8..7ee3bf40 100644
--- a/src/gaudio/sys_defs.h
+++ b/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);
diff --git a/src/gdisp/colors.h b/src/gdisp/colors.h
index efd7076c..6e9a7663 100644
--- a/src/gdisp/colors.h
+++ b/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
diff --git a/src/gdisp/image.h b/src/gdisp/image.h
index 607f1007..1bf378f1 100644
--- a/src/gdisp/image.h
+++ b/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
diff --git a/src/ginput/dial.h b/src/ginput/dial.h
index a90b5e46..f2d3fb58 100644
--- a/src/ginput/dial.h
+++ b/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
diff --git a/src/ginput/keyboard.h b/src/ginput/keyboard.h
index d2bebeb8..eff5cc6f 100644
--- a/src/ginput/keyboard.h
+++ b/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
diff --git a/src/ginput/mouse.h b/src/ginput/mouse.h
index 669eaec6..79ad1f08 100644
--- a/src/ginput/mouse.h
+++ b/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
diff --git a/src/ginput/toggle.h b/src/ginput/toggle.h
index 73cf1e27..40149754 100644
--- a/src/ginput/toggle.h
+++ b/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
diff --git a/src/gos/chibios.h b/src/gos/chibios.h
index 1db9482e..3da247b1 100644
--- a/src/gos/chibios.h
+++ b/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.
*/
diff --git a/src/gos/linux.h b/src/gos/linux.h
index f92fc4e9..9dd054da 100644
--- a/src/gos/linux.h
+++ b/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.
*/
diff --git a/src/gos/osx.h b/src/gos/osx.h
index 80b07eec..f01f4424 100644
--- a/src/gos/osx.h
+++ b/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.
*/
diff --git a/src/gos/raw32.h b/src/gos/raw32.h
index d4e8e548..9a4beb7f 100644
--- a/src/gos/raw32.h
+++ b/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
*/
diff --git a/src/gos/sys_defs.h b/src/gos/sys_defs.h
index f10ddd62..0fd162dc 100644
--- a/src/gos/sys_defs.h
+++ b/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
diff --git a/src/gos/win32.h b/src/gos/win32.h
index 8a5d9025..4a198200 100644
--- a/src/gos/win32.h
+++ b/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.
*/
diff --git a/src/gqueue/sys_defs.h b/src/gqueue/sys_defs.h
index ea3f176e..b675cbcc 100644
--- a/src/gqueue/sys_defs.h
+++ b/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
* @{
diff --git a/src/gwin/button.h b/src/gwin/button.h
index d11764d6..dad0cc91 100644
--- a/src/gwin/button.h
+++ b/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
diff --git a/src/gwin/checkbox.h b/src/gwin/checkbox.h
index 946f7e4a..529fc757 100644
--- a/src/gwin/checkbox.h
+++ b/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
diff --git a/src/gwin/class_gwin.h b/src/gwin/class_gwin.h
index ae5ac756..49fc6084 100644
--- a/src/gwin/class_gwin.h
+++ b/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
diff --git a/src/gwin/console.h b/src/gwin/console.h
index 14bc7eb3..3fca6aa4 100644
--- a/src/gwin/console.h
+++ b/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
diff --git a/src/gwin/graph.h b/src/gwin/graph.h
index 65a64126..69dbb617 100644
--- a/src/gwin/graph.h
+++ b/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
diff --git a/src/gwin/gwidget.h b/src/gwin/gwidget.h
index 4eaf6c81..96832fe3 100644
--- a/src/gwin/gwidget.h
+++ b/src/gwin/gwidget.h
@@ -6,7 +6,7 @@
*/
/**
- * @file include/gwin/gwidget.h
+ * @file src/gwin/gwidget.h
* @brief GWIN Widgets header file.
*/
diff --git a/src/gwin/image.h b/src/gwin/image.h
index 66aba3d1..fdaabc92 100644
--- a/src/gwin/image.h
+++ b/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
diff --git a/src/gwin/label.c b/src/gwin/label.c
index 97588a27..a5064818 100644
--- a/src/gwin/label.c
+++ b/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
diff --git a/src/gwin/label.h b/src/gwin/label.h
index 3fe0f3d7..9d62738d 100644
--- a/src/gwin/label.h
+++ b/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
diff --git a/src/gwin/list.c b/src/gwin/list.c
index 5b49811c..8374ff39 100644
--- a/src/gwin/list.c
+++ b/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
diff --git a/src/gwin/list.h b/src/gwin/list.h
index cfe6aeb2..eb800439 100644
--- a/src/gwin/list.h
+++ b/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
diff --git a/src/gwin/progressbar.h b/src/gwin/progressbar.h
index c9efe46b..de10783f 100644
--- a/src/gwin/progressbar.h
+++ b/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
diff --git a/src/gwin/radio.h b/src/gwin/radio.h
index 3ee2918f..f2bd7f35 100644
--- a/src/gwin/radio.h
+++ b/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
diff --git a/src/gwin/slider.h b/src/gwin/slider.h
index 8f87745c..8c5bd9ca 100644
--- a/src/gwin/slider.h
+++ b/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
diff --git a/src/gwin/sys_defs.h b/src/gwin/sys_defs.h
index 10b5b564..98c153d0 100644
--- a/src/gwin/sys_defs.h
+++ b/src/gwin/sys_defs.h
@@ -439,6 +439,8 @@ extern "C" {
*
* @param[in] gh The window
*
+ * @return ToDo
+ *
* @api
*/
GWindowMinMax gwinGetMinMax(GHandle gh);
diff --git a/src/gwin/sys_options.h b/src/gwin/sys_options.h
index e7bb93b4..656e0e3f 100644
--- a/src/gwin/sys_options.h
+++ b/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