aboutsummaryrefslogtreecommitdiffstats
path: root/include/gadc/lld/gadc_lld.h
diff options
context:
space:
mode:
authorJoel Bodenmann <joel@unormal.org>2013-03-10 20:17:24 +0100
committerJoel Bodenmann <joel@unormal.org>2013-03-10 20:17:24 +0100
commit426a12de6b6de40e576424b0a6391f528dc8a1ed (patch)
tree1a4a745e73bcf33714ead537206677b8f05d3922 /include/gadc/lld/gadc_lld.h
parent2088f0fe67c2137c7feddd682639b32497569e76 (diff)
downloaduGFX-426a12de6b6de40e576424b0a6391f528dc8a1ed.tar.gz
uGFX-426a12de6b6de40e576424b0a6391f528dc8a1ed.tar.bz2
uGFX-426a12de6b6de40e576424b0a6391f528dc8a1ed.zip
doxygen fixes
Diffstat (limited to 'include/gadc/lld/gadc_lld.h')
-rw-r--r--include/gadc/lld/gadc_lld.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/include/gadc/lld/gadc_lld.h b/include/gadc/lld/gadc_lld.h
index f9cc8b47..d32928c1 100644
--- a/include/gadc/lld/gadc_lld.h
+++ b/include/gadc/lld/gadc_lld.h
@@ -103,11 +103,12 @@ void gadc_lld_init(void);
* @brief Get the number of samples in a conversion.
* @details Calculates and returns the number of samples per conversion for the specified physdev.
*
- * @param[in] physdev A value passed to describe which physical ADC devices/channels to use.
- *
* @note A physdev describing a mono device would return 1, a stereo device would return 2.
* For most ADC's physdev is a bitmap so it is only a matter of counting the bits.
*
+ * @param[in] physdev A value passed to describe which physical ADC devices/channels to use.
+ *
+ * @return Number of samples of the convesion
* @api
*/
size_t gadc_lld_samples_per_conversion(uint32_t physdev);