Merge pull request #19 from scalar-labs/fix/update_doc

update doc
scalar-labs · Jul 13, 2020 · e7b68d7 · e7b68d7
2 parents febd709 + 1abce12
commit e7b68d7
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/src/main/java/com/scalar/kelpie/modules/FrequencyBasedProcessor.java b/src/main/java/com/scalar/kelpie/modules/FrequencyBasedProcessor.java
@@ -47,6 +47,8 @@ public final void execute() {
    * Execute an operation. This method is invoked repeatedly in {@link #execute()} by {@code
    * num_operations}. If a failure which you don't want to record its latency happens, this method
    * should throw an exception. The exception will be caught in {@link #execute()}.
+   *
+   * @throws Exception This exception will be caught in {@link #execute()}
    */
   protected abstract void executeEach() throws Exception;
 }
diff --git a/src/main/java/com/scalar/kelpie/modules/TimeBasedProcessor.java b/src/main/java/com/scalar/kelpie/modules/TimeBasedProcessor.java
@@ -46,6 +46,8 @@ public final void execute() {
    * Execute an operation. This method is invoked repeatedly in {@link #execute()} for {@code
    * run_for_sec}. If a failure which you don't want to record its latency happens, this method
    * should throw an exception. The exception will be caught in {@link #execute()}.
+   *
+   * @throws Exception This exception will be caught in {@link #execute()}
    */
   protected abstract void executeEach() throws Exception;
 }