Small fixes to the documentation.
Small corrections to the documentation. This CL changes the files
used to generate the docs & the corresponding header files. The
actual .jd documentation files are fixed in another CL.
b/23190418
Change-Id: I3632a4f867cbfa7d4e0de6c3ffcb07533130531b
diff --git a/scriptc/rs_allocation_data.rsh b/scriptc/rs_allocation_data.rsh
index 69e9baf..57b6660 100644
--- a/scriptc/rs_allocation_data.rsh
+++ b/scriptc/rs_allocation_data.rsh
@@ -600,7 +600,7 @@
* mono dimensional allocations.
*
* For efficiency, this function does not validate the inputs. Trying to wrap the
- * X index, exceeding the size of the allocation, or using indexes incompatible
+ * X index, exceeding the size of the allocation, or using indices incompatible
* with the dimensionality of the allocation yiels undefined results.
*
* See also rsAllocationVLoadX().
diff --git a/scriptc/rs_convert.rsh b/scriptc/rs_convert.rsh
index 66e47c6..f6380ba 100644
--- a/scriptc/rs_convert.rsh
+++ b/scriptc/rs_convert.rsh
@@ -1251,10 +1251,10 @@
*
* Packs three or four floating point RGBA values into a uchar4.
*
- * The input values are typically between 0.0 and 1.0 inclusive. For input values outside
+ * The input values are typically between 0.0f and 1.0f inclusive. For input values outside
* of this range, the resulting outputs will be clamped to be between 0 and 255. As this
* clamping may be done after the input is multiplied by 255.f and converted to an integer,
- * input numbers greater than INT_MAX/255.f or less than INT_MIN/255.f can result in
+ * input numbers greater than INT_MAX/255.f or less than INT_MIN/255.f result in
* undefined behavior.
*
* If the alpha component is not specified, it is assumed to be 1.0, i.e. the result will
diff --git a/scriptc/rs_for_each.rsh b/scriptc/rs_for_each.rsh
index 9507c0c..9771d09 100644
--- a/scriptc/rs_for_each.rsh
+++ b/scriptc/rs_for_each.rsh
@@ -22,7 +22,7 @@
* The rsForEach() function can be used to invoke the root kernel of a script.
*
* The other functions are used to get the characteristics of the invocation of
- * an executing kernel, like dimensions and current indexes. These functions take
+ * an executing kernel, like dimensions and current indices. These functions take
* a rs_kernel_context as argument.
*/
@@ -51,13 +51,10 @@
* rs_kernel_context: Handle to a kernel invocation context
*
* The kernel context contains common characteristics of the allocations being iterated
- * over, like dimensions, and rarely used indexes, like the Array0 index or the current
- * level of detail.
+ * over, like dimensions. It also contains rarely used indices of the currently processed
+ * cell, like the Array0 index or the current level of detail.
*
- * A kernel may be executed in parallel over multiple threads. Each thread will have its
- * own context.
- *
- * You can access the context by adding a special parameter named "context" and of type
+ * You can access the kernel context by adding a special parameter named "context" of type
* rs_kernel_context to your kernel function. See rsGetDimX() and rsGetArray0() for examples.
*/
#if (defined(RS_VERSION) && (RS_VERSION >= 23))
@@ -152,21 +149,20 @@
#endif
/*
- * rsGetArray0: Index in the Array0 dimension for the specified context
+ * rsGetArray0: Index in the Array0 dimension for the specified kernel context
*
* Returns the index in the Array0 dimension of the cell being processed, as specified
- * by the supplied context.
+ * by the supplied kernel context.
*
- * This context is created when a kernel is launched and updated at each iteration.
- * It contains common characteristics of the allocations being iterated over and rarely
- * used indexes, like the Array0 index.
+ * The kernel context contains common characteristics of the allocations being iterated
+ * over and rarely used indices, like the Array0 index.
*
- * You can access the context by adding a special parameter named "context" and of
+ * You can access the kernel context by adding a special parameter named "context" of
* type rs_kernel_context to your kernel function. E.g.
* short RS_KERNEL myKernel(short value, uint32_t x, rs_kernel_context context) {
- * // The current index in the common x, y, z, w dimensions are accessed by
- * // adding these variables as arguments. For the more rarely used indexes
- * // to the other dimensions, extract them from the context:
+ * // The current index in the common x, y, z dimensions are accessed by
+ * // adding these variables as arguments. For the more rarely used indices
+ * // to the other dimensions, extract them from the kernel context:
* uint32_t index_a0 = rsGetArray0(context);
* //...
* }
@@ -179,10 +175,10 @@
#endif
/*
- * rsGetArray1: Index in the Array1 dimension for the specified context
+ * rsGetArray1: Index in the Array1 dimension for the specified kernel context
*
* Returns the index in the Array1 dimension of the cell being processed, as specified
- * by the supplied context. See rsGetArray0() for an explanation of the context.
+ * by the supplied kernel context. See rsGetArray0() for an explanation of the context.
*
* Returns 0 if the Array1 dimension is not present.
*/
@@ -192,10 +188,10 @@
#endif
/*
- * rsGetArray2: Index in the Array2 dimension for the specified context
+ * rsGetArray2: Index in the Array2 dimension for the specified kernel context
*
* Returns the index in the Array2 dimension of the cell being processed,
- * as specified by the supplied context. See rsGetArray0() for an explanation
+ * as specified by the supplied kernel context. See rsGetArray0() for an explanation
* of the context.
*
* Returns 0 if the Array2 dimension is not present.
@@ -206,10 +202,10 @@
#endif
/*
- * rsGetArray3: Index in the Array3 dimension for the specified context
+ * rsGetArray3: Index in the Array3 dimension for the specified kernel context
*
* Returns the index in the Array3 dimension of the cell being processed, as specified
- * by the supplied context. See rsGetArray0() for an explanation of the context.
+ * by the supplied kernel context. See rsGetArray0() for an explanation of the context.
*
* Returns 0 if the Array3 dimension is not present.
*/
@@ -219,9 +215,9 @@
#endif
/*
- * rsGetDimArray0: Size of the Array0 dimension for the specified context
+ * rsGetDimArray0: Size of the Array0 dimension for the specified kernel context
*
- * Returns the size of the Array0 dimension for the specified context.
+ * Returns the size of the Array0 dimension for the specified kernel context.
* See rsGetDimX() for an explanation of the context.
*
* Returns 0 if the Array0 dimension is not present.
@@ -232,9 +228,9 @@
#endif
/*
- * rsGetDimArray1: Size of the Array1 dimension for the specified context
+ * rsGetDimArray1: Size of the Array1 dimension for the specified kernel context
*
- * Returns the size of the Array1 dimension for the specified context.
+ * Returns the size of the Array1 dimension for the specified kernel context.
* See rsGetDimX() for an explanation of the context.
*
* Returns 0 if the Array1 dimension is not present.
@@ -245,9 +241,9 @@
#endif
/*
- * rsGetDimArray2: Size of the Array2 dimension for the specified context
+ * rsGetDimArray2: Size of the Array2 dimension for the specified kernel context
*
- * Returns the size of the Array2 dimension for the specified context.
+ * Returns the size of the Array2 dimension for the specified kernel context.
* See rsGetDimX() for an explanation of the context.
*
* Returns 0 if the Array2 dimension is not present.
@@ -258,9 +254,9 @@
#endif
/*
- * rsGetDimArray3: Size of the Array3 dimension for the specified context
+ * rsGetDimArray3: Size of the Array3 dimension for the specified kernel context
*
- * Returns the size of the Array3 dimension for the specified context.
+ * Returns the size of the Array3 dimension for the specified kernel context.
* See rsGetDimX() for an explanation of the context.
*
* Returns 0 if the Array3 dimension is not present.
@@ -271,10 +267,10 @@
#endif
/*
- * rsGetDimHasFaces: Presence of more than one face for the specified context
+ * rsGetDimHasFaces: Presence of more than one face for the specified kernel context
*
- * If the context refers to a cubemap, this function returns true if there's more than
- * one face present. In all other cases, it returns false. See rsGetDimX() for an
+ * If the kernel is iterating over a cubemap, this function returns true if there's more
+ * than one face present. In all other cases, it returns false. See rsGetDimX() for an
* explanation of the context.
*
* rsAllocationGetDimFaces() is similar but returns 0 or 1 instead of a bool.
@@ -287,9 +283,9 @@
#endif
/*
- * rsGetDimLod: Number of levels of detail for the specified context
+ * rsGetDimLod: Number of levels of detail for the specified kernel context
*
- * Returns the number of levels of detail for the specified context. This is useful
+ * Returns the number of levels of detail for the specified kernel context. This is useful
* for mipmaps. See rsGetDimX() for an explanation of the context.
*
* Returns 0 if Level of Detail is not used.
@@ -303,15 +299,14 @@
#endif
/*
- * rsGetDimX: Size of the X dimension for the specified context
+ * rsGetDimX: Size of the X dimension for the specified kernel context
*
- * Returns the size of the X dimension for the specified context.
+ * Returns the size of the X dimension for the specified kernel context.
*
- * This context is created when a kernel is launched. It contains common
- * characteristics of the allocations being iterated over by the kernel in
- * a very efficient structure. It also contains rarely used indexes.
+ * The kernel context contains common characteristics of the allocations being iterated
+ * over and rarely used indices, like the Array0 index.
*
- * You can access it by adding a special parameter named "context" and of
+ * You can access it by adding a special parameter named "context" of
* type rs_kernel_context to your kernel function. E.g.
* int4 RS_KERNEL myKernel(int4 value, rs_kernel_context context) {
* uint32_t size = rsGetDimX(context); //...
@@ -324,9 +319,9 @@
#endif
/*
- * rsGetDimY: Size of the Y dimension for the specified context
+ * rsGetDimY: Size of the Y dimension for the specified kernel context
*
- * Returns the size of the X dimension for the specified context.
+ * Returns the size of the X dimension for the specified kernel context.
* See rsGetDimX() for an explanation of the context.
*
* Returns 0 if the Y dimension is not present.
@@ -339,9 +334,9 @@
#endif
/*
- * rsGetDimZ: Size of the Z dimension for the specified context
+ * rsGetDimZ: Size of the Z dimension for the specified kernel context
*
- * Returns the size of the Z dimension for the specified context.
+ * Returns the size of the Z dimension for the specified kernel context.
* See rsGetDimX() for an explanation of the context.
*
* Returns 0 if the Z dimension is not present.
@@ -354,10 +349,10 @@
#endif
/*
- * rsGetFace: Coordinate of the Face for the specified context
+ * rsGetFace: Coordinate of the Face for the specified kernel context
*
* Returns the face on which the cell being processed is found, as specified by the
- * supplied context. See rsGetArray0() for an explanation of the context.
+ * supplied kernel context. See rsGetArray0() for an explanation of the context.
*
* Returns RS_ALLOCATION_CUBEMAP_FACE_POSITIVE_X if the face dimension is not
* present.
@@ -368,10 +363,10 @@
#endif
/*
- * rsGetLod: Index in the Levels of Detail dimension for the specified context
+ * rsGetLod: Index in the Levels of Detail dimension for the specified kernel context
*
* Returns the index in the Levels of Detail dimension of the cell being processed,
- * as specified by the supplied context. See rsGetArray0() for an explanation of
+ * as specified by the supplied kernel context. See rsGetArray0() for an explanation of
* the context.
*
* Returns 0 if the Levels of Detail dimension is not present.