Skip to content

Commit f0bdae2

Browse files
committed
Bring back the groups that doxygen (1.9?) has dropped
1 parent c04b188 commit f0bdae2

File tree

6 files changed

+17
-3
lines changed

6 files changed

+17
-3
lines changed

AutoMap.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@
2121

2222
#include "AutoRange.h"
2323

24+
/** @defgroup sensortools Automatic range adjustment
25+
*/
26+
2427
/** @ingroup sensortools
2528
Automatically map an input value to an output range without knowing the precise range of inputs beforehand.
2629
*/

IntegerType.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33

44
#include <Arduino.h>
55

6+
/** @ingroup util
7+
Provides appropriate integer types that can bit the given number of bytes on this platform (at most 64).
8+
*/
69
template<uint8_t BYTES> struct IntegerType {
710
// at an odd value, such as 3 bytes? Add one more byte (up to at most 8 bytes)..
811
typedef typename IntegerType<(BYTES < 8) ? (BYTES+1) : 8>::unsigned_type unsigned_type;

config/mozzi_config_documentation.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
#ifdef FOR_DOXYGEN_ONLY
22
/** @file */
33

4-
/*! @defgroup config Mozzi Configuration options
5-
* @brief Mozzi Configuration
4+
/*! @defgroup config Mozzi Configuration options */
5+
6+
/** @ingroup config
7+
* @page config_main Mozzi Configuration
68
*
79
* @section config_general Configuring Mozzi
810
*

meta.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Template meta-programming extras.
66
#ifndef META_H_
77
#define META_H_
88

9+
/** @defgroup util Assorted meta-programming utils
10+
*/
911

1012
/** @ingroup util
1113
Enables you to instantiate a template based on an integer value.

mozzi_analog.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
// for setupFastAnalogRead()
2020
enum ANALOG_READ_SPEED {FAST_ADC,FASTER_ADC,FASTEST_ADC};
2121

22+
/** @defgroup analog Functions for taking (non-blocking) analog readings. */
23+
2224
/**
2325
@ingroup analog
2426
This is automatically called in startMozzi.

mozzi_fixmath.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@
1818
#include "WProgram.h"
1919
#endif
2020

21-
/**@ingroup fixmath
21+
/** @defgroup fixmath Fast integer based fixed-point arithmetic */
22+
23+
/** @ingroup fixmath
2224
@{
2325
*/
2426
// types

0 commit comments

Comments
 (0)