Skip to content

Commit

Permalink
Cleaned up documentation for libraries
Browse files Browse the repository at this point in the history
  • Loading branch information
k105la committed Aug 8, 2020
1 parent 547675c commit 88b9242
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 9 deletions.
10 changes: 3 additions & 7 deletions board/adc/adc.c
Original file line number Diff line number Diff line change
@@ -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++) {
Expand All @@ -30,3 +25,4 @@ float adcRead(void) {
return calibrated_adc_value;
}

/** @} */ // end of group1
2 changes: 1 addition & 1 deletion board/mpx5100/mpx5100.c
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@


/** @defgroup group2 MPX5100 Library
* This is library interfaces with the mpx5100.
* This library interfaces with the MPX5100.
* @{
*/

Expand Down
3 changes: 2 additions & 1 deletion board/usart/usart.c
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,5 @@ int print(char c, FILE *stream) {
UDR0 = c;
return 0;
}


/** @} */ // end of group3

0 comments on commit 88b9242

Please sign in to comment.