fix fabric8io#3398 adding a javadoc about wait

shawkins · Sep 15, 2021 · 464e99e · 464e99e
1 parent 04e0b2e
commit 464e99e
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/Scaleable.java b/kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/Scaleable.java
@@ -22,8 +22,21 @@ public interface Scaleable<T> {
 
   int POLL_INTERVAL_MS = 100;
 
+  /**
+   * Scale the resource to given count
+   * @param count
+   * @param wait
+   * @return the resource
+   */
   T scale(int count);
 
+  /**
+   * Scale the resource to given count
+   * @param count
+   * @param wait if true, wait for the number of instances to exist - no guarantee is made
+   * as to readiness 
+   * @return the resource
+   */
   T scale(int count, boolean wait);
 
   Scale scale();