Improve some of the javadoc language around repeat count

Signed-off-by: James House <[email protected]>
quartz-scheduler · Oct 14, 2024 · 5271ad0 · 5271ad0
1 parent f3bbe5a
commit 5271ad0
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/quartz/src/main/java/org/quartz/SimpleScheduleBuilder.java b/quartz/src/main/java/org/quartz/SimpleScheduleBuilder.java
@@ -325,10 +325,10 @@ public SimpleScheduleBuilder withIntervalInHours(int intervalInHours) {
     }
 
     /**
-     * Specify a the number of time the trigger will repeat - total number of 
+     * Specify the number of times the trigger will repeat - the total number of
      * firings will be this number + 1. 
      * 
-     * @param triggerRepeatCount the number of seconds at which the trigger should repeat.
+     * @param triggerRepeatCount the number of times the trigger should repeat after the initial firing.
      * @return the updated SimpleScheduleBuilder
      * @see SimpleTrigger#getRepeatCount()
      * @see #repeatForever()

diff --git a/quartz/src/main/java/org/quartz/SimpleTrigger.java b/quartz/src/main/java/org/quartz/SimpleTrigger.java
@@ -138,11 +138,12 @@ public interface SimpleTrigger extends Trigger {
     public static final int REPEAT_INDEFINITELY = -1;
 
     /**
-     * <p>
      * Get the number of times the <code>SimpleTrigger</code> should
-     * repeat, after which it will be automatically deleted.
-     * </p>
-     * 
+     * repeat, after the initial firing, after which it will be automatically deleted.
+     *
+     * The total number of firings will be this number + 1.
+     *
+     * @return the number of times the trigger should repeat after the initial firing.
      * @see #REPEAT_INDEFINITELY
      */
     public int getRepeatCount();