Skip to content

Commit

Permalink
Resolved lack of javadoc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
adelgadoj3 committed Mar 11, 2024
1 parent 8adb91c commit 4fff773
Showing 1 changed file with 7 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
import java.io.File;
import java.util.Scanner;
import java.io.FileNotFoundException;

/**
* The PassiveBuzzerHelper class contains methods that pertain to the control of the passive buzzer.
*/
public class PassiveBuzzerHelper {

private static final Logger log = LoggerFactory.getLogger(PassiveBuzzerHelper.class);
Expand All @@ -24,7 +28,9 @@ public PassiveBuzzerHelper( Pwm passiveBuzzer){
}

/**
* Initializes passive buzzer to a 50% duty cycle and frequency of 440Hz
* @param passBuzzDC sets the passive buzzer to the desired duty cycle
*
* @param passiveBuzzerFreq sets the passive buzzer to the desired frequency
*/
//tag::method[]
public void passiveBuzzerOn(int passBuzzDC, int passiveBuzzerFreq){
Expand Down

0 comments on commit 4fff773

Please sign in to comment.