From e121691ac2442e29bf8e63e76d0d5d10983022c3 Mon Sep 17 00:00:00 2001
From: "Pfifer, Justin" <pfifer@amazon.com>
Date: Fri, 19 May 2017 08:29:42 -0700
Subject: [PATCH] Cleanup the Writing of the IdleTimeBetweenMillis
 Documentation

---
 .../lib/worker/KinesisClientLibConfiguration.java   | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)

diff --git a/src/main/java/com/amazonaws/services/kinesis/clientlibrary/lib/worker/KinesisClientLibConfiguration.java b/src/main/java/com/amazonaws/services/kinesis/clientlibrary/lib/worker/KinesisClientLibConfiguration.java
index 422838c34..02450cb8d 100644
--- a/src/main/java/com/amazonaws/services/kinesis/clientlibrary/lib/worker/KinesisClientLibConfiguration.java
+++ b/src/main/java/com/amazonaws/services/kinesis/clientlibrary/lib/worker/KinesisClientLibConfiguration.java
@@ -791,12 +791,12 @@ public KinesisClientLibConfiguration withMaxRecords(int maxRecords) {
     }
 
     /**
-     * Controls how long the {@link ShardConsumer} will sleep if no records are returned from the call to
-     * {@link com.amazonaws.services.kinesis.AmazonKinesis#getRecords(com.amazonaws.services.kinesis.model.GetRecordsRequest)}.
+     * Controls how long the KCL will sleep if no records are returned from Kinesis
      *
-     * This sleep is only used when no records are returned. If records are returned the {@link ShardConsumer} will
+     * <p>
+     * This value is only used when no records are returned; if records are returned, the {@link com.amazonaws.services.kinesis.clientlibrary.lib.worker.ProcessTask} will
      * immediately retrieve the next set of records after the call to
-     * {@link com.amazonaws.services.kinesis.clientlibrary.interfaces.v2.IRecordProcessor#processRecords(com.amazonaws.services.kinesis.clientlibrary.types.ProcessRecordsInput)}
+     * {@link com.amazonaws.services.kinesis.clientlibrary.interfaces.v2.IRecordProcessor#processRecords(ProcessRecordsInput)}
      * has returned. Setting this value to high may result in the KCL being unable to catch up. If you are changing this
      * value it's recommended that you enable {@link #withCallProcessRecordsEvenForEmptyRecordList(boolean)}, and
      * monitor how far behind the records retrieved are by inspecting
@@ -804,11 +804,10 @@ public KinesisClientLibConfiguration withMaxRecords(int maxRecords) {
      * <a href=
      * "http://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html#kinesis-metrics-stream">CloudWatch
      * Metric: GetRecords.MillisBehindLatest</a>
+     * </p>
      *
      * @param idleTimeBetweenReadsInMillis
-     *            how long to sleep calls to
-     *            {@link com.amazonaws.services.kinesis.AmazonKinesis#getRecords(com.amazonaws.services.kinesis.model.GetRecordsRequest)}
-     *            when no records are returned.
+     *            how long to sleep between GetRecords calls when no records are returned.
      * @return KinesisClientLibConfiguration
      */
     public KinesisClientLibConfiguration withIdleTimeBetweenReadsInMillis(long idleTimeBetweenReadsInMillis) {