Merge pull request #491 from oss-slu/add-missing-javadoc

Add missing Javadocs

Author: leandrumartin

pi4micronaut-utils/src/main/java/com/opensourcewithslu/inputdevices/ReedSwitchHelper.java

@@ -5,6 +5,9 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * Helper for monitoring a reed switch input.
+ */
 public class ReedSwitchHelper {
     private static final Logger log = LoggerFactory.getLogger(ReedSwitchHelper.class);
 

pi4micronaut-utils/src/main/java/com/opensourcewithslu/inputdevices/ThermistorHelper.java

@@ -4,6 +4,9 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * Helper for reading thermistor values through an ADC.
+ */
 public class ThermistorHelper {
     private static final Logger log = LoggerFactory.getLogger(ThermistorHelper.class);
     private final Spi spi; // SPI interface for ADC communication

pi4micronaut-utils/src/main/java/com/opensourcewithslu/outputdevices/FourDigitSevenSegmentDisplayHelper.java

@@ -6,6 +6,9 @@
 
 import java.util.Map;
 
+/**
+ * Helper for controlling a four-digit seven-segment display.
+ */
 public class FourDigitSevenSegmentDisplayHelper {
     private static Logger log = LoggerFactory.getLogger(FourDigitSevenSegmentDisplayHelper.class);
 

pi4micronaut-utils/src/main/java/com/opensourcewithslu/outputdevices/LEDHelper.java

@@ -16,9 +16,9 @@ public class LEDHelper {
     private final DigitalOutput ledOutput;
 
     /**
+     * LEDHelper constructor.
      *
-     * LEGHelper constructor.
-     * @param ledOutput An instance of a Pi4J DigitalOutput object.
+     * @param ledOutput an instance of a Pi4J DigitalOutput object
      */
     //tag::const[]
     public LEDHelper(DigitalOutput ledOutput)
@@ -72,10 +72,9 @@ public void switchState()
     }
 
     /**
+     * Blinks the LED for the specified duration.
      *
-     * @param duration blink will take the duration parameter and have the led
-     *                 blink for that duration.
-     *
+     * @param duration the duration to blink in milliseconds
      */
 
     public void blink (int duration) {

pi4micronaut-utils/src/main/java/com/opensourcewithslu/outputdevices/PassiveBuzzerHelper.java

@@ -62,8 +62,9 @@ public void passiveBuzzerOff(){
     }
 
     /**
+     * Returns the current default frequency for the passive buzzer.
      *
-     * Logs the passiveBuzzerFreq to the console
+     * @return the current default frequency in Hz
      */
 
     //tag::method[]
@@ -158,6 +159,11 @@ public void piToneSequence(){
         passiveBuzzerOff();
     }
 
+    /**
+     * Sleeps for the specified duration.
+     *
+     * @param duration the time to sleep in milliseconds
+     */
     protected void sleep(long duration){
         try {
             Thread.sleep(duration); // Play each frequency for the specified duration