Skip to content

Commit eace09c

Browse files
committed
clarifying units as Hz
1 parent 1e46c0c commit eace09c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/sfeQwiicBuzzer.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,14 @@ class sfeQwiicBuzzer
5656
/// causing buzzing by using the physical TRIGGER pin.
5757
/// To start buzzing (via Qwiic) with your desired configuration, use this
5858
/// function, then call setBuzzerActiveReg().
59-
/// @param toneFrequency Frequency of buzzer tone
59+
/// @param toneFrequency Frequency in Hz of buzzer tone
6060
/// @param duration Duration in milliseconds
6161
/// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
6262
/// @return 0 for succuss, negative for errors, positive for warnings
6363
sfeTkError_t configureBuzzer(const uint16_t toneFrequency, const uint16_t duration, const uint8_t volume);
6464

6565
/// @brief Configures the Qwiic Buzzer with default values
66-
/// @param toneFrequency Frequency of buzzer tone
66+
/// @param toneFrequency Frequency in Hz of buzzer tone
6767
/// @param duration Duration in milliseconds
6868
/// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
6969
/// @return 0 for succuss, negative for errors, positive for warnings

0 commit comments

Comments
 (0)