Skip to content

Commit b3558e0

Browse files
fixing documentation issues
1 parent ed1c2ac commit b3558e0

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

src/CapacitiveTouch.h

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
// Define a symbolic constant for the LOVE button (special pin).
1616
#define LOVE_BUTTON 20
1717

18-
#define CALIBRATION_SAMPLES 16 ///< Number of samples for calibration.
19-
18+
// Number of samples for calibration.
19+
#define CALIBRATION_SAMPLES 16
2020
/**
2121
* @struct CapTouchPinMapping
2222
* @brief Defines the mapping between an Arduino pin and its capacitive touch hardware settings.
@@ -32,7 +32,6 @@ struct CapTouchPinMapping {
3232
uint8_t chac_val; ///< Bit mask used to enable the sensor channel.
3333
};
3434

35-
/// @endcond
3635

3736
#if defined(ARDUINO_UNOR4_MINIMA)
3837
static const CapTouchPinMapping capTouchMappings[] = {
@@ -105,8 +104,8 @@ class CapacitiveTouch {
105104

106105
/**
107106
* @brief Initializes the sensor.
108-
*
109107
* Configures the pin and initializes the CTSU/DTC hardware.
108+
* @return true if initialization is successful, false otherwise.
110109
*/
111110
bool begin();
112111

0 commit comments

Comments
 (0)