Improve RS documentation.

bug 8570568
Change-Id: I465fcc8ec3e2cc892dc3cb0067aacf5224338102

1 files changed, 6 insertions, 48 deletions

diff --git a/graphics/java/android/renderscript/Script.java b/graphics/java/android/renderscript/Script.java
index f0579ca24c2b..0026e0edbfba 100644
--- a/graphics/java/android/renderscript/Script.java
+++ b/graphics/java/android/renderscript/Script.java
@@ -19,7 +19,8 @@ package android.renderscript;
 import android.util.SparseArray;
 
 /**
- *
+ * The parent class for all executable scripts. This should not be used by
+ * applications.
  **/
 public class Script extends BaseObj {
 
@@ -46,14 +47,6 @@ public class Script extends BaseObj {
     private final SparseArray<KernelID> mKIDs = new SparseArray<KernelID>();
     /**
      * Only to be used by generated reflected classes.
-     *
-     *
-     * @param slot
-     * @param sig
-     * @param ein
-     * @param eout
-     *
-     * @return KernelID
      */
     protected KernelID createKernelID(int slot, int sig, Element ein, Element eout) {
         KernelID k = mKIDs.get(slot);
@@ -92,11 +85,6 @@ public class Script extends BaseObj {
     private final SparseArray<FieldID> mFIDs = new SparseArray();
     /**
      * Only to be used by generated reflected classes.
-     *
-     * @param slot
-     * @param e
-     *
-     * @return FieldID
      */
     protected FieldID createFieldID(int slot, Element e) {
         FieldID f = mFIDs.get(slot);
@@ -118,7 +106,6 @@ public class Script extends BaseObj {
     /**
      * Only intended for use by generated reflected code.
      *
-     * @param slot
      */
     protected void invoke(int slot) {
         mRS.nScriptInvoke(getID(mRS), slot);
@@ -127,8 +114,6 @@ public class Script extends BaseObj {
     /**
      * Only intended for use by generated reflected code.
      *
-     * @param slot
-     * @param v
      */
     protected void invoke(int slot, FieldPacker v) {
         if (v != null) {
@@ -141,10 +126,6 @@ public class Script extends BaseObj {
     /**
      * Only intended for use by generated reflected code.
      *
-     * @param slot
-     * @param ain
-     * @param aout
-     * @param v
      */
     protected void forEach(int slot, Allocation ain, Allocation aout, FieldPacker v) {
         if (ain == null && aout == null) {
@@ -169,11 +150,6 @@ public class Script extends BaseObj {
     /**
      * Only intended for use by generated reflected code.
      *
-     * @param slot
-     * @param ain
-     * @param aout
-     * @param v
-     * @param sc
      */
     protected void forEach(int slot, Allocation ain, Allocation aout, FieldPacker v, LaunchOptions sc) {
         if (ain == null && aout == null) {
@@ -208,8 +184,6 @@ public class Script extends BaseObj {
     /**
      * Only intended for use by generated reflected code.
      *
-     * @param va
-     * @param slot
      */
     public void bindAllocation(Allocation va, int slot) {
         mRS.validate();
@@ -223,8 +197,6 @@ public class Script extends BaseObj {
     /**
      * Only intended for use by generated reflected code.
      *
-     * @param index
-     * @param v
      */
     public void setVar(int index, float v) {
         mRS.nScriptSetVarF(getID(mRS), index, v);
@@ -236,8 +208,6 @@ public class Script extends BaseObj {
     /**
      * Only intended for use by generated reflected code.
      *
-     * @param index
-     * @param v
      */
     public void setVar(int index, double v) {
         mRS.nScriptSetVarD(getID(mRS), index, v);
@@ -249,8 +219,6 @@ public class Script extends BaseObj {
     /**
      * Only intended for use by generated reflected code.
      *
-     * @param index
-     * @param v
      */
     public void setVar(int index, int v) {
         mRS.nScriptSetVarI(getID(mRS), index, v);
@@ -263,8 +231,6 @@ public class Script extends BaseObj {
     /**
      * Only intended for use by generated reflected code.
      *
-     * @param index
-     * @param v
      */
     public void setVar(int index, long v) {
         mRS.nScriptSetVarJ(getID(mRS), index, v);
@@ -277,8 +243,6 @@ public class Script extends BaseObj {
     /**
      * Only intended for use by generated reflected code.
      *
-     * @param index
-     * @param v
      */
     public void setVar(int index, boolean v) {
         mRS.nScriptSetVarI(getID(mRS), index, v ? 1 : 0);
@@ -290,8 +254,6 @@ public class Script extends BaseObj {
     /**
      * Only intended for use by generated reflected code.
      *
-     * @param index
-     * @param o
      */
     public void setVar(int index, BaseObj o) {
         mRS.nScriptSetVarObj(getID(mRS), index, (o == null) ? 0 : o.getID(mRS));
@@ -300,8 +262,6 @@ public class Script extends BaseObj {
     /**
      * Only intended for use by generated reflected code.
      *
-     * @param index
-     * @param v
      */
     public void setVar(int index, FieldPacker v) {
         mRS.nScriptSetVarV(getID(mRS), index, v.getData());
@@ -310,10 +270,6 @@ public class Script extends BaseObj {
     /**
      * Only intended for use by generated reflected code.
      *
-     * @param index
-     * @param v
-     * @param e
-     * @param dims
      */
     public void setVar(int index, FieldPacker v, Element e, int[] dims) {
         mRS.nScriptSetVarVE(getID(mRS), index, v.getData(), e.getID(mRS), dims);
@@ -322,8 +278,6 @@ public class Script extends BaseObj {
     /**
      * Only intended for use by generated reflected code.
      *
-     * @param index
-     * @param v
      */
     public void getVarV(int index, FieldPacker v) {
         mRS.nScriptGetVarV(getID(mRS), index, v.getData());
@@ -338,6 +292,10 @@ public class Script extends BaseObj {
         }
     }
 
+    /**
+     * Only intended for use by generated reflected code.
+     *
+     */
     public static class Builder {
         RenderScript mRS;