Skip to content

Commit c3ce97f

Browse files
committed
removing incorrect comments
sound effects don't return anything
1 parent a60205f commit c3ce97f

File tree

1 file changed

+0
-11
lines changed

1 file changed

+0
-11
lines changed

src/sfeQwiicBuzzer.h

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -83,57 +83,46 @@ class sfeQwiicBuzzerArdI2C
8383
/// @brief Plays one of the sound effects included in this library
8484
/// @param soundEffectNumber The sound effect you with to play
8585
/// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
86-
/// @return 0 for succuss, negative for errors, positive for warnings
8786
void playSoundEffect(uint8_t soundEffectNumber, uint8_t volume);
8887

8988
/// @brief Plays sound effect 0
9089
/// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
91-
/// @return 0 for succuss, negative for errors, positive for warnings
9290
void soundEffect0(uint8_t volume);
9391

9492
/// @brief Plays sound effect 1
9593
/// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
96-
/// @return 0 for succuss, negative for errors, positive for warnings
9794
void soundEffect1(uint8_t volume);
9895

9996
/// @brief Plays sound effect 2
10097
/// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
101-
/// @return 0 for succuss, negative for errors, positive for warnings
10298
void soundEffect2(uint8_t volume);
10399

104100
/// @brief Plays sound effect 3
105101
/// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
106-
/// @return 0 for succuss, negative for errors, positive for warnings
107102
void soundEffect3(uint8_t volume);
108103

109104
/// @brief Plays sound effect 4
110105
/// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
111-
/// @return 0 for succuss, negative for errors, positive for warnings
112106
void soundEffect4(uint8_t volume);
113107

114108
/// @brief Plays sound effect 5
115109
/// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
116-
/// @return 0 for succuss, negative for errors, positive for warnings
117110
void soundEffect5(uint8_t volume);
118111

119112
/// @brief Plays sound effect 6
120113
/// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
121-
/// @return 0 for succuss, negative for errors, positive for warnings
122114
void soundEffect6(uint8_t volume);
123115

124116
/// @brief Plays sound effect 7
125117
/// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
126-
/// @return 0 for succuss, negative for errors, positive for warnings
127118
void soundEffect7(uint8_t volume);
128119

129120
/// @brief Plays sound effect 8
130121
/// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
131-
/// @return 0 for succuss, negative for errors, positive for warnings
132122
void soundEffect8(uint8_t volume);
133123

134124
/// @brief Plays sound effect 9
135125
/// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
136-
/// @return 0 for succuss, negative for errors, positive for warnings
137126
void soundEffect9(uint8_t volume);
138127

139128
/// @brief Changes the I2C address of the Qwiic Buzzer

0 commit comments

Comments
 (0)