Add "deprecated:" flag to the spec files.
Also cleanup of the documentation found in the header and html files.
Change-Id: I8a606d1af93b0fd0f912ac23aabdb73aa99233b4
diff --git a/scriptc/rs_matrix.rsh b/scriptc/rs_matrix.rsh
index 32496db..169d2b2 100644
--- a/scriptc/rs_matrix.rsh
+++ b/scriptc/rs_matrix.rsh
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-// Don't edit this file! It is auto-generated by frameworks/rs/api/gen_runtime.
+// Don't edit this file! It is auto-generated by frameworks/rs/api/generate.sh.
/*
* rs_matrix.rsh: Matrix functions
@@ -44,6 +44,7 @@
* on a matrix that already does a scaling, the resulting matrix when applied
* to a vector will first do the translation then the scaling.
*/
+
#ifndef RENDERSCRIPT_RS_MATRIX_RSH
#define RENDERSCRIPT_RS_MATRIX_RSH
@@ -53,13 +54,13 @@
* Computes 6 frustum planes from the view projection matrix
*
* Parameters:
- * viewProj matrix to extract planes from
- * left left plane
- * right right plane
- * top top plane
- * bottom bottom plane
- * near near plane
- * far far plane
+ * viewProj: matrix to extract planes from
+ * left: left plane
+ * right: right plane
+ * top: top plane
+ * bottom: bottom plane
+ * near: near plane
+ * far: far plane
*/
static inline void __attribute__((always_inline, overloadable))
rsExtractFrustumPlanes(const rs_matrix4x4* viewProj, float4* left, float4* right, float4* top,
@@ -113,13 +114,13 @@
* Checks if a sphere is withing the 6 frustum planes
*
* Parameters:
- * sphere float4 representing the sphere
- * left left plane
- * right right plane
- * top top plane
- * bottom bottom plane
- * near near plane
- * far far plane
+ * sphere: float4 representing the sphere
+ * left: left plane
+ * right: right plane
+ * top: top plane
+ * bottom: bottom plane
+ * near: near plane
+ * far: far plane
*/
static inline bool __attribute__((always_inline, overloadable))
rsIsSphereInFrustum(float4* sphere, float4* left, float4* right, float4* top, float4* bottom,
@@ -159,9 +160,9 @@
* Warning: The order of the column and row parameters may be unexpected.
*
* Parameters:
- * m The matrix to extract the element from.
- * col The zero-based column of the element to be extracted.
- * row The zero-based row of the element to extracted.
+ * m: The matrix to extract the element from.
+ * col: The zero-based column of the element to be extracted.
+ * row: The zero-based row of the element to extracted.
*/
extern float __attribute__((overloadable))
rsMatrixGet(const rs_matrix4x4* m, uint32_t col, uint32_t row);
@@ -178,7 +179,7 @@
* Returns true if the matrix was successfully inverted.
*
* Parameters:
- * m The matrix to invert.
+ * m: The matrix to invert.
*/
extern bool __attribute__((overloadable))
rsMatrixInverse(rs_matrix4x4* m);
@@ -190,7 +191,7 @@
* Returns true if the matrix was successfully inverted.
*
* Parameters:
- * m The matrix to modify.
+ * m: The matrix to modify.
*/
extern bool __attribute__((overloadable))
rsMatrixInverseTranspose(rs_matrix4x4* m);
@@ -215,9 +216,9 @@
*
*
* Parameters:
- * destination The matrix to set.
- * array The array of values to set the matrix to. These arrays should be 4, 9, or 16 floats long, depending on the matrix size.
- * source The source matrix.
+ * destination: The matrix to set.
+ * array: The array of values to set the matrix to. These arrays should be 4, 9, or 16 floats long, depending on the matrix size.
+ * source: The source matrix.
*/
extern void __attribute__((overloadable))
rsMatrixLoad(rs_matrix4x4* destination, const float* array);
@@ -254,7 +255,7 @@
* created matrix using rsMatrixMultiply().
*
* Parameters:
- * m The matrix to set.
+ * m: The matrix to set.
*/
extern void __attribute__((overloadable))
rsMatrixLoadFrustum(rs_matrix4x4* m, float left, float right, float bottom, float top,
@@ -266,7 +267,7 @@
* Set the elements of a matrix to the identity matrix.
*
* Parameters:
- * m The matrix to set.
+ * m: The matrix to set.
*/
extern void __attribute__((overloadable))
rsMatrixLoadIdentity(rs_matrix4x4* m);
@@ -293,9 +294,9 @@
* rsMatrixLoadMultiply (&m2l, &m2r, &m2l) works as expected.
*
* Parameters:
- * m The matrix to set.
- * lhs The left matrix of the product.
- * rhs The right matrix of the product.
+ * m: The matrix to set.
+ * lhs: The left matrix of the product.
+ * rhs: The right matrix of the product.
*/
extern void __attribute__((overloadable))
rsMatrixLoadMultiply(rs_matrix4x4* m, const rs_matrix4x4* lhs, const rs_matrix4x4* rhs);
@@ -320,7 +321,7 @@
* See https://en.wikipedia.org/wiki/Orthographic_projection .
*
* Parameters:
- * m The matrix to set.
+ * m: The matrix to set.
*/
extern void __attribute__((overloadable))
rsMatrixLoadOrtho(rs_matrix4x4* m, float left, float right, float bottom, float top, float near,
@@ -335,11 +336,11 @@
* created matrix using rsMatrixMultiply().
*
* Parameters:
- * m The matrix to set.
- * fovy Field of view, in degrees along the Y axis.
- * aspect Ratio of x / y.
- * near The near clipping plane.
- * far The far clipping plane.
+ * m: The matrix to set.
+ * fovy: Field of view, in degrees along the Y axis.
+ * aspect: Ratio of x / y.
+ * near: The near clipping plane.
+ * far: The far clipping plane.
*/
extern void __attribute__((overloadable))
rsMatrixLoadPerspective(rs_matrix4x4* m, float fovy, float aspect, float near, float far);
@@ -356,11 +357,11 @@
* See http://en.wikipedia.org/wiki/Rotation_matrix .
*
* Parameters:
- * m The matrix to set.
- * rot How much rotation to do, in degrees.
- * x The x component of the vector that is the axis of rotation.
- * y The y component of the vector that is the axis of rotation.
- * z The z component of the vector that is the axis of rotation.
+ * m: The matrix to set.
+ * rot: How much rotation to do, in degrees.
+ * x: The x component of the vector that is the axis of rotation.
+ * y: The y component of the vector that is the axis of rotation.
+ * z: The z component of the vector that is the axis of rotation.
*/
extern void __attribute__((overloadable))
rsMatrixLoadRotate(rs_matrix4x4* m, float rot, float x, float y, float z);
@@ -375,10 +376,10 @@
* using rsMatrixMultiply().
*
* Parameters:
- * m The matrix to set.
- * x The multiple to scale the x components by.
- * y The multiple to scale the y components by.
- * z The multiple to scale the z components by.
+ * m: The matrix to set.
+ * x: The multiple to scale the x components by.
+ * y: The multiple to scale the y components by.
+ * z: The multiple to scale the z components by.
*/
extern void __attribute__((overloadable))
rsMatrixLoadScale(rs_matrix4x4* m, float x, float y, float z);
@@ -393,10 +394,10 @@
* using rsMatrixMultiply().
*
* Parameters:
- * m The matrix to set.
- * x The number to add to each x component.
- * y The number to add to each y component.
- * z The number to add to each z component.
+ * m: The matrix to set.
+ * x: The number to add to each x component.
+ * y: The number to add to each y component.
+ * z: The number to add to each z component.
*/
extern void __attribute__((overloadable))
rsMatrixLoadTranslate(rs_matrix4x4* m, float x, float y, float z);
@@ -422,8 +423,8 @@
* Starting with API 14, this function takes a const matrix as the first argument.
*
* Parameters:
- * m The left matrix of the product and the matrix to be set.
- * rhs The right matrix of the product.
+ * m: The left matrix of the product and the matrix to be set.
+ * rhs: The right matrix of the product.
*/
extern void __attribute__((overloadable))
rsMatrixMultiply(rs_matrix4x4* m, const rs_matrix4x4* rhs);
@@ -506,11 +507,11 @@
* the vector by the created matrix using rsMatrixMultiply().
*
* Parameters:
- * m The matrix to modify.
- * rot How much rotation to do, in degrees.
- * x The x component of the vector that is the axis of rotation.
- * y The y component of the vector that is the axis of rotation.
- * z The z component of the vector that is the axis of rotation.
+ * m: The matrix to modify.
+ * rot: How much rotation to do, in degrees.
+ * x: The x component of the vector that is the axis of rotation.
+ * y: The y component of the vector that is the axis of rotation.
+ * z: The z component of the vector that is the axis of rotation.
*/
extern void __attribute__((overloadable))
rsMatrixRotate(rs_matrix4x4* m, float rot, float x, float y, float z);
@@ -528,10 +529,10 @@
* the vector by the created matrix using rsMatrixMultiply().
*
* Parameters:
- * m The matrix to modify.
- * x The multiple to scale the x components by.
- * y The multiple to scale the y components by.
- * z The multiple to scale the z components by.
+ * m: The matrix to modify.
+ * x: The multiple to scale the x components by.
+ * y: The multiple to scale the y components by.
+ * z: The multiple to scale the z components by.
*/
extern void __attribute__((overloadable))
rsMatrixScale(rs_matrix4x4* m, float x, float y, float z);
@@ -544,10 +545,10 @@
* Warning: The order of the column and row parameters may be unexpected.
*
* Parameters:
- * m The matrix that will be modified.
- * col The zero-based column of the element to be set.
- * row The zero-based row of the element to be set.
- * v The value to set.
+ * m: The matrix that will be modified.
+ * col: The zero-based column of the element to be set.
+ * row: The zero-based row of the element to be set.
+ * v: The value to set.
*/
extern void __attribute__((overloadable))
rsMatrixSet(rs_matrix4x4* m, uint32_t col, uint32_t row, float v);
@@ -571,10 +572,10 @@
* the vector by the created matrix using rsMatrixMultiply().
*
* Parameters:
- * m The matrix to modify.
- * x The number to add to each x component.
- * y The number to add to each y component.
- * z The number to add to each z component.
+ * m: The matrix to modify.
+ * x: The number to add to each x component.
+ * y: The number to add to each y component.
+ * z: The number to add to each z component.
*/
extern void __attribute__((overloadable))
rsMatrixTranslate(rs_matrix4x4* m, float x, float y, float z);
@@ -585,7 +586,7 @@
* Transpose the matrix m in place.
*
* Parameters:
- * m The matrix to transpose.
+ * m: The matrix to transpose.
*/
extern void __attribute__((overloadable))
rsMatrixTranspose(rs_matrix4x4* m);