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_math.rsh b/scriptc/rs_math.rsh
index b812f07..f78a0e1 100644
--- a/scriptc/rs_math.rsh
+++ b/scriptc/rs_math.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_math.rsh: Mathematical functions
@@ -41,11 +41,12 @@
*
* Different precision/speed tradeoffs can be achieved by using three variants
* of common math functions. Functions with a name starting with
- * native_ may have custom hardware implementations with weaker precision,
- * half_ may perform internal computations using 16 bit floats, and
- * fast_ are n-dimensional space computations that may use 16 bit floats.
+ * - native_ may have custom hardware implementations with weaker precision,
+ * - half_ may perform internal computations using 16 bit floats, and
+ * - fast_ are n-dimensional space computations that may use 16 bit floats.
*
*/
+
#ifndef RENDERSCRIPT_RS_MATH_RSH
#define RENDERSCRIPT_RS_MATH_RSH
@@ -334,8 +335,8 @@
* See also native_atan2().
*
* Parameters:
- * numerator The numerator
- * denominator The denominator. Can be 0.
+ * numerator: The numerator
+ * denominator: The denominator. Can be 0.
*/
extern float __attribute__((const, overloadable))
atan2(float numerator, float denominator);
@@ -359,8 +360,8 @@
* See also native_atan2pi().
*
* Parameters:
- * numerator The numerator
- * denominator The denominator. Can be 0.
+ * numerator: The numerator
+ * denominator: The denominator. Can be 0.
*/
extern float __attribute__((const, overloadable))
atan2pi(float numerator, float denominator);
@@ -466,9 +467,9 @@
* If min_value is greater than max_value, the results are undefined.
*
* Parameters:
- * value Value to be clamped.
- * min_value Lower bound, a scalar or matching vector.
- * max_value High bound, must match the type of low.
+ * value: Value to be clamped.
+ * min_value: Lower bound, a scalar or matching vector.
+ * max_value: High bound, must match the type of low.
*/
extern float __attribute__((const, overloadable))
clamp(float value, float min_value, float max_value);
@@ -1224,8 +1225,8 @@
* fract(-1.3f, &val) returns 0.7f and sets val to -2.f.
*
* Parameters:
- * v Input value.
- * floor If floor is not null, *floor will be set to the floor of v.
+ * v: Input value.
+ * floor: If floor is not null, *floor will be set to the floor of v.
*/
extern float __attribute__((overloadable))
fract(float v, float* floor);
@@ -1273,8 +1274,8 @@
* See ldexp() for the reverse operation. See also logb() and ilogb().
*
* Parameters:
- * v Input value.
- * exponent If exponent is not null, *exponent will be set to the exponent of v.
+ * v: Input value.
+ * exponent: If exponent is not null, *exponent will be set to the exponent of v.
*/
extern float __attribute__((overloadable))
frexp(float v, int* exponent);
@@ -1428,8 +1429,8 @@
* See frexp() for the reverse operation.
*
* Parameters:
- * mantissa The mantissa
- * exponent The exponent, a single component or matching vector.
+ * mantissa: The mantissa
+ * exponent: The exponent, a single component or matching vector.
*/
extern float __attribute__((const, overloadable))
ldexp(float mantissa, int exponent);
@@ -1461,7 +1462,7 @@
* See also tgamma().
*
* Parameters:
- * sign_of_gamma If sign_of_gamma is not null, *sign_of_gamma will be set to -1.f if the gamma of v is negative, otherwise to 1.f.
+ * sign_of_gamma: If sign_of_gamma is not null, *sign_of_gamma will be set to -1.f if the gamma of v is negative, otherwise to 1.f.
*/
extern float __attribute__((const, overloadable))
lgamma(float v);
@@ -2480,8 +2481,8 @@
* Both components will have the same sign as x. For example, for an input of -3.72f, iret will be set to -3.f and .72f will be returned.
*
* Parameters:
- * v Source value
- * integral_part *integral_part will be set to the integral portion of the number.
+ * v: Source value
+ * integral_part: *integral_part will be set to the integral portion of the number.
*
* Returns: The floating point portion of the value.
*/
@@ -2503,7 +2504,7 @@
* Returns a NaN value (Not a Number).
*
* Parameters:
- * v Not used.
+ * v: Not used.
*/
extern float __attribute__((const, overloadable))
nan(uint v);
@@ -2721,8 +2722,8 @@
* See also atan2().
*
* Parameters:
- * numerator The numerator
- * denominator The denominator. Can be 0.
+ * numerator: The numerator
+ * denominator: The denominator. Can be 0.
*/
#if (defined(RS_VERSION) && (RS_VERSION >= 21))
extern float __attribute__((const, overloadable))
@@ -2754,8 +2755,8 @@
* See also atan2pi().
*
* Parameters:
- * numerator The numerator
- * denominator The denominator. Can be 0.
+ * numerator: The numerator
+ * denominator: The denominator. Can be 0.
*/
#if (defined(RS_VERSION) && (RS_VERSION >= 21))
extern float __attribute__((const, overloadable))
@@ -3231,8 +3232,8 @@
* See also powr().
*
* Parameters:
- * base Must be between 0.f and 256.f. The function is not accurate for values very close to zero.
- * exponent Must be between -15.f and 15.f.
+ * base: Must be between 0.f and 256.f. The function is not accurate for values very close to zero.
+ * exponent: Must be between -15.f and 15.f.
*/
#if (defined(RS_VERSION) && (RS_VERSION >= 18))
extern float __attribute__((const, overloadable))
@@ -3370,8 +3371,8 @@
* See also sincos().
*
* Parameters:
- * v The incoming value in radians.
- * cos *cos will be set to the cosine value.
+ * v: The incoming value in radians.
+ * cos: *cos will be set to the cosine value.
*
* Returns: sine
*/
@@ -3689,9 +3690,9 @@
* Example: remquo(-23.5f, 8.f, ") sets the lowest three bits of quot to 3 and the sign negative. It returns 0.5f.
*
* Parameters:
- * numerator The numerator.
- * denominator The denominator.
- * quotient *quotient will be set to the integer quotient.
+ * numerator: The numerator.
+ * denominator: The denominator.
+ * quotient: *quotient will be set to the integer quotient.
*
* Returns: The remainder, precise only for the low three bits.
*/
@@ -3835,8 +3836,8 @@
* See also native_sincos().
*
* Parameters:
- * v The incoming value in radians
- * cos *cos will be set to the cosine value.
+ * v: The incoming value in radians
+ * cos: *cos will be set to the cosine value.
*
* Returns: sine of v
*/
@@ -4061,9 +4062,9 @@
* Deprecated. Use clamp() instead.
*
* Parameters:
- * amount The value to clamp
- * low Lower bound
- * high Upper bound
+ * amount: The value to clamp
+ * low: Lower bound
+ * high: Upper bound
*/
extern char __attribute__((const, always_inline, overloadable))
rsClamp(char amount, char low, char high);