Javadoc adjustments

googleapis · Apr 7, 2016 · 3ba911a · 3ba911a
1 parent 07e467c
commit 3ba911a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/gcloud-java-core/src/main/java/com/google/gcloud/RetryParams.java b/gcloud-java-core/src/main/java/com/google/gcloud/RetryParams.java
@@ -165,7 +165,7 @@ public Builder retryDelayBackoffFactor(double retryDelayBackoffFactor) {
     /**
      * Sets totalRetryPeriodMillis. Note that App Engine Standard Environment front-end modules have
      * a 60 second deadline for HTTP requests. For that reason, you should set the total retry
-     * period to under 60 seconds if you are using the App Engine front-end module.
+     * period to under 60 seconds if you are using it on an App Engine front-end module.
      *
      * @param totalRetryPeriodMillis the totalRetryPeriodMillis to set
      * @return the Builder for chaining

diff --git a/gcloud-java-core/src/main/java/com/google/gcloud/ServiceOptions.java b/gcloud-java-core/src/main/java/com/google/gcloud/ServiceOptions.java
@@ -655,6 +655,11 @@ private static <T> T newInstance(String className) throws IOException, ClassNotF
 
   public abstract <B extends Builder<ServiceT, ServiceRpcT, OptionsT, B>> B toBuilder();
 
+  /**
+   * Some services may have different backoff requirements listed in their SLAs. Be sure to override
+   * this method in options subclasses when the service's backoff requirement differs from the
+   * default parameters listed in {@link RetryParams}.
+   */
   protected RetryParams defaultRetryParams() {
     return RetryParams.defaultInstance();
   }