Merge pull request #490 from oss-slu/245-improve-javadoc-documentation-for-servomotorhelper-class

Improve ServoMotorHelper Javadocs

Author: leandrumartin

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

@@ -30,8 +30,8 @@ public ServoMotorHelper(Pwm servoMotor) {
     }
 
     /**
-     * Enables the servo motor by setting an initial duty cycle and frequency.
-     * The servo motor remains disabled until this method is called.
+     * Enables the servo motor by starting PWM output at 0% duty cycle and the
+     * configured servo frequency.
      */
     public void enable() {
         log.info("Enabling servo motor");
@@ -40,7 +40,7 @@ public void enable() {
     }
 
     /**
-     * Disables the servo motor, effectively stopping any ongoing PWM signal.
+     * Disables the servo motor and stops PWM output.
      */
     public void disable() {
         log.info("Disabling servo motor");
@@ -60,7 +60,11 @@ float map(float value) {
 
     /**
      * Sets the servo motor to a specific angle.
-     * This method calculates the necessary pulse width and duty cycle to achieve the specified angle.
+     * <p>
+     * The angle must be between 0 and 180 degrees. Values outside that range
+     * are ignored and logged. This method also waits briefly after updating the
+     * PWM signal so the servo has time to move.
+     * </p>
      *
      * @param angle the target angle for the servo motor, between 0 and 180 degrees.
      */
@@ -90,7 +94,7 @@ public void setAngle(int angle) {
     }
 
     /**
-     * Sets the logger for this ServoMotorHelper instance.
+     * Sets the logger for this {@code ServoMotorHelper} instance.
      * This method is intended for internal testing purposes only.
      *
      * @param logger the logger to be used for logging messages.