Merge pull request #453 from oss-slu/Rename-FahHelper-parameter-to-trigger-Javadoc-regeneration

Small documentation corrections to trigger Javadoc regeneration

Author: leandrumartin

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

@@ -17,10 +17,10 @@ public class FanHelper {
     /**
      * Constructor to initialize the FanHelper with a PWM instance.
      *
-     * @param fa the PWM instance to control the fan
+     * @param fan the PWM instance to control the fan
      */
-    public FanHelper(Pwm fa) {
-        this.pwm = fa;
+    public FanHelper(Pwm fan) {
+        this.pwm = fan;
     }
 
     /**
@@ -48,7 +48,7 @@ public void stop() {
     /**
      * Sets the fan speed by adjusting the PWM duty cycle.
      *
-     * @param speed the desired fan speed (duty cycle), must be between 0 and 1024
+     * @param speed the desired fan speed (duty cycle). Must be between 0 and 1024.
      * @throws IllegalArgumentException if the speed is out of bounds
      */
     public void setSpeed(int speed) {
@@ -58,4 +58,4 @@ public void setSpeed(int speed) {
         log.info("Setting fan speed to {}", speed);
         pwm.on(speed);  // Adjust the duty cycle based on the speed
     }
-}
+}

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

@@ -64,7 +64,7 @@ public void disable()
      * Sets the speed of the DC motor.
      * This method calculates the necessary pulse width and duty cycle to achieve the specified speed.
      *
-     * @param speed the target speed for the motor, as a percentage between 0 and 1.
+     * @param speed the target speed for the motor, as a percentage between 0 and 100.
      */
     //tag::[method]
     public void setSpeed(double speed)