From 88b92422b3704597b2a232f18da5498ce96794af Mon Sep 17 00:00:00 2001 From: akilhylton Date: Fri, 7 Aug 2020 21:36:02 -0400 Subject: [PATCH] Cleaned up documentation for libraries --- board/adc/adc.c | 10 +++------- board/mpx5100/mpx5100.c | 2 +- board/usart/usart.c | 3 ++- 3 files changed, 6 insertions(+), 9 deletions(-) diff --git a/board/adc/adc.c b/board/adc/adc.c index decb9b5..a400b78 100644 --- a/board/adc/adc.c +++ b/board/adc/adc.c @@ -1,22 +1,17 @@ #include "../driver/adc.h" - - - /** @defgroup group1 TinyADC Library * This is a minimal ADC Library with init and read functions only. * @{ */ -/** @brief class C1 in group 1 */ - +/** Enables ADC. */ void adcInit(void) { - /// Enables ADC. ADCSRA = (1 << ADEN) | (1 << ADSC); } +/** Returns calibrated adc values.*/ float adcRead(void) { - /// Returns calibrated adc values. float sum = 0; // Sum of averaged adc values int adc_values_arr[N]; for (int i = 0; i < N; i++) { @@ -30,3 +25,4 @@ float adcRead(void) { return calibrated_adc_value; } +/** @} */ // end of group1 diff --git a/board/mpx5100/mpx5100.c b/board/mpx5100/mpx5100.c index 8448f77..1c08ea7 100644 --- a/board/mpx5100/mpx5100.c +++ b/board/mpx5100/mpx5100.c @@ -2,7 +2,7 @@ /** @defgroup group2 MPX5100 Library - * This is library interfaces with the mpx5100. + * This library interfaces with the MPX5100. * @{ */ diff --git a/board/usart/usart.c b/board/usart/usart.c index 7dd56a1..59bc181 100644 --- a/board/usart/usart.c +++ b/board/usart/usart.c @@ -38,4 +38,5 @@ int print(char c, FILE *stream) { UDR0 = c; return 0; } - + +/** @} */ // end of group3