Merge changes I596e00fa,I89fda42d into nyc-dev

am: 44f546a

* commit '44f546aa68231f466e629e53240030f9cefc3e84':
  [RenderScript] Fix IntrinsicConvolve documentation.
  [RenderScript] Update the documentation of Script.LaunchOptions

Change-Id: Ib2ffa5a97d5bbc8264f3442d20aecf3ddec65ef1

3 files changed, 34 insertions, 19 deletions

diff --git a/support/java/src/android/support/v8/renderscript/Script.java b/support/java/src/android/support/v8/renderscript/Script.java
index 814622e4..3b2f90a5 100644
--- a/support/java/src/android/support/v8/renderscript/Script.java
+++ b/support/java/src/android/support/v8/renderscript/Script.java
@@ -594,7 +594,23 @@ public class Script extends BaseObj {
 
 
     /**
-     * Class used to specify clipping for a kernel launch.
+     * Class for specifying the specifics about how a kernel will be
+     * launched.
+     *
+     * This class can specify a potential range of cells on which to
+     * run a kernel.  If no set is called for a dimension then this
+     * class will have no impact on that dimension when the kernel
+     * is executed.
+     *
+     * The forEach kernel launch will operate over the intersection of
+     * the dimensions.
+     *
+     * Example:
+     * LaunchOptions with setX(5, 15)
+     * Allocation with dimension X=10, Y=10
+     * The resulting forEach run would execute over:
+     * x = 5 to 9 (inclusive) and
+     * y = 0 to 9 (inclusive).
      *
      */
     public static final class LaunchOptions {
@@ -607,11 +623,11 @@ public class Script extends BaseObj {
         private int strategy;
 
         /**
-         * Set the X range.  If the end value is set to 0 the X dimension is not
-         * clipped.
+         * Set the X range. xstartArg is the lowest coordinate of the range,
+         * and xendArg-1 is the highest coordinate of the range.
          *
          * @param xstartArg Must be >= 0
-         * @param xendArg Must be >= xstartArg
+         * @param xendArg Must be > xstartArg
          *
          * @return LaunchOptions
          */
@@ -625,11 +641,11 @@ public class Script extends BaseObj {
         }
 
         /**
-         * Set the Y range.  If the end value is set to 0 the Y dimension is not
-         * clipped.
+         * Set the Y range. ystartArg is the lowest coordinate of the range,
+         * and yendArg-1 is the highest coordinate of the range.
          *
          * @param ystartArg Must be >= 0
-         * @param yendArg Must be >= ystartArg
+         * @param yendArg Must be > ystartArg
          *
          * @return LaunchOptions
          */
@@ -643,11 +659,11 @@ public class Script extends BaseObj {
         }
 
         /**
-         * Set the Z range.  If the end value is set to 0 the Z dimension is not
-         * clipped.
+         * Set the Z range. zstartArg is the lowest coordinate of the range,
+         * and zendArg-1 is the highest coordinate of the range.
          *
          * @param zstartArg Must be >= 0
-         * @param zendArg Must be >= zstartArg
+         * @param zendArg Must be > zstartArg
          *
          * @return LaunchOptions
          */
diff --git a/support/java/src/android/support/v8/renderscript/ScriptIntrinsicConvolve3x3.java b/support/java/src/android/support/v8/renderscript/ScriptIntrinsicConvolve3x3.java
index 0d398b74..e6a6b7e2 100644
--- a/support/java/src/android/support/v8/renderscript/ScriptIntrinsicConvolve3x3.java
+++ b/support/java/src/android/support/v8/renderscript/ScriptIntrinsicConvolve3x3.java
@@ -36,10 +36,9 @@ public class ScriptIntrinsicConvolve3x3 extends ScriptIntrinsic {
      * Supported elements types are {@link Element#U8}, {@link
      * Element#U8_2}, {@link Element#U8_3}, {@link Element#U8_4},
      * {@link Element#F32}, {@link Element#F32_2}, {@link
-     * Element#F32_3}, and {@link Element#F32_4}
-     *
-     * The default coefficients are.
+     * Element#F32_3}, and {@link Element#F32_4}.
      *
+     * <p> The default coefficients are:
      * <code>
      * <p> [ 0,  0,  0 ]
      * <p> [ 0,  1,  0 ]
@@ -76,7 +75,7 @@ public class ScriptIntrinsicConvolve3x3 extends ScriptIntrinsic {
     }
 
     /**
-     * Set the input of the blur.
+     * Set the input of the 3x3 convolve.
      * Must match the element type supplied during create.
      *
      * @param ain The input allocation.
@@ -89,7 +88,7 @@ public class ScriptIntrinsicConvolve3x3 extends ScriptIntrinsic {
     /**
      * Set the coefficients for the convolve.
      *
-     * The convolve layout is
+     * <p> The convolve layout is:
      * <code>
      * <p> [ 0,  1,  2 ]
      * <p> [ 3,  4,  5 ]
diff --git a/support/java/src/android/support/v8/renderscript/ScriptIntrinsicConvolve5x5.java b/support/java/src/android/support/v8/renderscript/ScriptIntrinsicConvolve5x5.java
index 9dd9cba2..17397fa2 100644
--- a/support/java/src/android/support/v8/renderscript/ScriptIntrinsicConvolve5x5.java
+++ b/support/java/src/android/support/v8/renderscript/ScriptIntrinsicConvolve5x5.java
@@ -36,9 +36,9 @@ public class ScriptIntrinsicConvolve5x5 extends ScriptIntrinsic {
      * Supported elements types are {@link Element#U8}, {@link
      * Element#U8_2}, {@link Element#U8_3}, {@link Element#U8_4},
      * {@link Element#F32}, {@link Element#F32_2}, {@link
-     * Element#F32_3}, and {@link Element#F32_4}
+     * Element#F32_3}, and {@link Element#F32_4}.
      *
-     * The default coefficients are.
+     * <p> The default coefficients are:
      * <code>
      * <p> [ 0,  0,  0,  0,  0  ]
      * <p> [ 0,  0,  0,  0,  0  ]
@@ -76,7 +76,7 @@ public class ScriptIntrinsicConvolve5x5 extends ScriptIntrinsic {
     }
 
     /**
-     * Set the input of the blur.
+     * Set the input of the 5x5 convolve.
      * Must match the element type supplied during create.
      *
      * @param ain The input allocation.
@@ -89,7 +89,7 @@ public class ScriptIntrinsicConvolve5x5 extends ScriptIntrinsic {
     /**
     * Set the coefficients for the convolve.
     *
-    * The convolve layout is
+    * <p> The convolve layout is:
     * <code>
     * <p> [ 0,  1,  2,  3,  4  ]
     * <p> [ 5,  6,  7,  8,  9  ]