doxygen fixes

2 files changed, 14 insertions, 8 deletions

diff --git a/include/gadc/gadc.h b/include/gadc/gadc.h
index bd35b30c..56be7cf5 100644
--- a/include/gadc/gadc.h
+++ b/include/gadc/gadc.h
@@ -93,7 +93,8 @@ typedef struct GEventADC_t {
 	 * @brief The buffer containing the conversion samples
 	 */
 	adcsample_t		*buffer;
-	} GEventADC;
+} GEventADC;
+/** @} */
 
 /**
  * @brief A callback function (executed in a thread context) for a low speed conversion
@@ -117,11 +118,11 @@ extern "C" {
  * @brief				Initialise the high speed ADC.
  * @details				Initialises but does not start the conversions.
  *
- * @param[in] physdev		A value passed to describe which physical ADC devices/channels to use.
- * @param[in] frequency		The frequency to create ADC conversions
- * @param[in] buffer		The static buffer to put the ADC samples into.
- * @param[in] bufcount		The total number of conversions that will fit in the buffer.
- * @param[in] countPerEvent	The number of conversions to do before returning an event.
+ * @param[in] physdev			A value passed to describe which physical ADC devices/channels to use.
+ * @param[in] frequency			The frequency to create ADC conversions
+ * @param[in] buffer			The static buffer to put the ADC samples into.
+ * @param[in] bufcount			The total number of conversions that will fit in the buffer.
+ * @param[in] samplesPerEvent	The number of conversions to do before returning an event.
  *
  * @note				If the high speed ADC is running it will be stopped. The Event subsystem is
  * 						disconnected from the high speed ADC and any binary semaphore event is forgotten.
@@ -166,6 +167,8 @@ void gadcHighSpeedInit(uint32_t physdev, uint32_t frequency, adcsample_t *buffer
 	 * @note				The high speed ADC is capable of signalling via this method, an ISR callback and a
 	 * 						binary semaphore at the same time.
 	 *
+	 * @return				The GSourceHandle
+	 *
 	 * @api
 	 */
 	GSourceHandle gadcHighSpeedGetSource(void);
@@ -249,6 +252,8 @@ void gadcLowSpeedGet(uint32_t physdev, adcsample_t *buffer);
  * @param[in] fn			The callback function to call when the conversion is complete.
  * @param[in] param			A parameter to pass to the callback function.
  *
+ * @return					FALSE if no free low speed ADC slots.
+ *
  * @note	This may be safely called from within a GTimer callback.
  * @note	The callback may take a while to occur if the high speed ADC is running as the
  * 			conversion is interleaved with the high speed ADC conversions on a buffer
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);