From 4fff77371148ff1410f2ae2f4ef9f624abebbc69 Mon Sep 17 00:00:00 2001
From: Alex Delgado <alexander.delgado@slu.edu>
Date: Mon, 11 Mar 2024 17:37:40 -0500
Subject: [PATCH] Resolved lack of javadoc comments

---
 .../outputdevices/PassiveBuzzerHelper.java                | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/pi4micronaut-utils/src/main/java/com/opensourcewithslu/outputdevices/PassiveBuzzerHelper.java b/pi4micronaut-utils/src/main/java/com/opensourcewithslu/outputdevices/PassiveBuzzerHelper.java
index b09c2c7a..2ea4bc81 100644
--- a/pi4micronaut-utils/src/main/java/com/opensourcewithslu/outputdevices/PassiveBuzzerHelper.java
+++ b/pi4micronaut-utils/src/main/java/com/opensourcewithslu/outputdevices/PassiveBuzzerHelper.java
@@ -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);
@@ -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){