aboutsummaryrefslogtreecommitdiffstats
path: root/src/gadc
diff options
context:
space:
mode:
authorinmarket <andrewh@inmarket.com.au>2014-03-30 14:59:17 +1000
committerinmarket <andrewh@inmarket.com.au>2014-03-30 14:59:17 +1000
commit87bef5d0df44f38f1e474ccf12f6daba06a743fe (patch)
tree7233d86b356eb7ccbe232428145b72c0c4bf6c7f /src/gadc
parent426c8a850f4e126879b5220a0537ca9b3910bc2b (diff)
downloaduGFX-87bef5d0df44f38f1e474ccf12f6daba06a743fe.tar.gz
uGFX-87bef5d0df44f38f1e474ccf12f6daba06a743fe.tar.bz2
uGFX-87bef5d0df44f38f1e474ccf12f6daba06a743fe.zip
Fill in some doxygen Todo's
Diffstat (limited to 'src/gadc')
-rw-r--r--src/gadc/driver.h8
1 files changed, 4 insertions, 4 deletions
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