Merge "Fix documentation for the cancelPending parameter" into androi…

…dx-main

graphics/graphics-core/src/main/java/androidx/graphics/lowlatency/GLFrontBufferedRenderer.kt

@@ -686,14 +686,14 @@ class GLFrontBufferedRenderer<T> @JvmOverloads constructor(
 
     /**
      * Releases the [GLFrontBufferedRenderer] and provides an optional callback that is invoked when
-     * the [GLFrontBufferedRenderer] is fully torn down. If the [cancelPending] flag is true, all
+     * the [GLFrontBufferedRenderer] is fully torn down. If the [cancelPending] flag is false, all
      * pending requests to render into the front or multi buffered layers will be processed before
-     * the [GLFrontBufferedRenderer] is torn down. Otherwise all in process requests are ignored.
+     * the [GLFrontBufferedRenderer] is torn down. Otherwise, all in progress requests are ignored.
      * If the [GLFrontBufferedRenderer] is already released, that is [isValid] returns `false`, this
      * method does nothing.
      *
-     * @param cancelPending Flag indicating that requests to render should be processed before
-     * the [GLFrontBufferedRenderer] is released
+     * @param cancelPending If true, pending render requests are cancelled immediately. If false,
+     * pending render requests are completed before releasing the renderer.
      * @param onReleaseComplete Optional callback invoked when the [GLFrontBufferedRenderer] has
      * been released. This callback is invoked on the backing GLThread
      */

graphics/graphics-core/src/main/java/androidx/graphics/opengl/GLFrameBufferRenderer.kt

@@ -474,8 +474,8 @@ class GLFrameBufferRenderer internal constructor(
      * the [GLFrameBufferRenderer] is in an invalid state and can no longer handle rendering
      * content.
      *
-     * @param cancelPending Flag to indicate that in process requests should be completed before
-     * the [GLFrameBufferRenderer] is released.
+     * @param cancelPending If true, pending render requests are cancelled immediately. If false,
+     * pending render requests are completed before releasing the renderer.
      * @param onReleaseCallback Optional callback to be invoked on the underlying OpenGL thread when
      * releasing resources has been completed
      */

graphics/graphics-core/src/main/java/androidx/graphics/opengl/GLRenderer.kt

@@ -242,7 +242,7 @@ class GLRenderer(
      * Note the stop operation will only occur if the GLRenderer was previously started, that is
      * [isRunning] returns true. Otherwise this is a no-op.
      *
-     * @param cancelPending If true all pending requests and cancelled and the backing thread is
+     * @param cancelPending If true, all pending requests are cancelled and the backing thread is
      * torn down immediately. If false, all pending requests are processed first before tearing
      * down the backing thread. Subsequent requests made after this call are ignored.
      * @param onStop Optional callback invoked on the backing thread after it is torn down.