From 87bef5d0df44f38f1e474ccf12f6daba06a743fe Mon Sep 17 00:00:00 2001
From: inmarket <andrewh@inmarket.com.au>
Date: Sun, 30 Mar 2014 14:59:17 +1000
Subject: Fill in some doxygen Todo's
---
src/gadc/driver.h | 8 ++++----
src/gwin/sys_defs.h | 2 +-
2 files changed, 5 insertions(+), 5 deletions(-)
(limited to 'src')
diff --git a/src/gadc/driver.h b/src/gadc/driver.h
index 450abbd3..e85eed48 100644
--- a/src/gadc/driver.h
+++ b/src/gadc/driver.h
@@ -85,11 +85,11 @@ extern "C" {
void gadc_lld_init(void);
/**
- * @brief Return the number of samples per conversion
+ * @brief Using the hardware dependant "physdev", return the number of samples for each conversion
*
* @param[in] physdev The hardware dependent physical device descriptor
*
- * @return ToDo
+ * @return The number of samples per conversion
*
* @api
*/
@@ -124,7 +124,7 @@ 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
+ * @param[in] pjob The job to be started.
*
* @api
* @iclass
@@ -136,7 +136,7 @@ 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
+ * @param[in] pjob The job to be started
*
* @api
* @iclass
diff --git a/src/gwin/sys_defs.h b/src/gwin/sys_defs.h
index 98c153d0..ac2c98c7 100644
--- a/src/gwin/sys_defs.h
+++ b/src/gwin/sys_defs.h
@@ -439,7 +439,7 @@ extern "C" {
*
* @param[in] gh The window
*
- * @return ToDo
+ * @return GWIN_NORMAL, GWIN_MAXIMIZE or GWIN_MINIMIZE
*
* @api
*/
--
cgit v1.2.3