Improve the documentation of the RenderScript API.
Only the explanations should be changing.
Change-Id: I889b366e3be44f5ac7f44a199e4b9a47353665e2
diff --git a/api/rs_time.spec b/api/rs_time.spec
index 8011393..208cced 100644
--- a/api/rs_time.spec
+++ b/api/rs_time.spec
@@ -15,9 +15,11 @@
#
header:
-summary: RenderScript time routines
+summary: Time Functions and Types
description:
- This file contains RenderScript functions relating to time and date manipulation.
+ The functions below can be used to tell the current clock time and the
+ current system up time. It's not recommended to call these functions
+ inside of a kernel.
end:
type: rs_time_t
@@ -52,7 +54,7 @@
function: rsGetDt
ret: float, "Time in seconds."
-summary:
+summary: Elapsed time since last call
description:
Returns the time in seconds since this function was last called in this
script.
@@ -60,31 +62,35 @@
end:
function: rsLocaltime
-ret: rs_tm*, "Pointer to broken-down time (same as input p local)."
-arg: rs_tm* local, "Broken-down time."
-arg: const rs_time_t* timer, "Input time as calendar time."
-summary:
+ret: rs_tm*, "Pointer to the output local time, i.e. the same value as the parameter local."
+arg: rs_tm* local, "Pointer to time structure where the local time will be stored."
+arg: const rs_time_t* timer, "Input time as a number of seconds since January 1, 1970."
+summary: Convert to local time
description:
- Converts the time specified by p timer into broken-down time and stores it
- in p local. This function also returns a pointer to p local. If p local
- is NULL, this function does nothing and returns NULL.
+ Converts the time specified by timer into a @rs_tm structure that provides year, month, hour, etc.
+ This value is stored at *local.
+
+ This functions returns the same pointer that is passed as first argument.
+ If the local parameter is NULL, this function does nothing and returns NULL.
test: none
end:
function: rsTime
-ret: rs_time_t, "Seconds since the Epoch."
+ret: rs_time_t, "Seconds since the Epoch, -1 if there's an error."
arg: rs_time_t* timer, "Location to also store the returned calendar time."
-summary:
+summary: Seconds since January 1, 1970
description:
Returns the number of seconds since the Epoch (00:00:00 UTC, January 1,
- 1970). If p timer is non-NULL, the result is also stored in the memory
- pointed to by this variable. If an error occurs, a value of -1 is returned.
+ 1970).
+
+ If timer is non-NULL, the result is also stored in the memory pointed to by
+ this variable.
test: none
end:
function: rsUptimeMillis
ret: int64_t, "Uptime in milliseconds."
-summary:
+summary: System uptime in milliseconds
description:
Returns the current system clock (uptime) in milliseconds.
test: none
@@ -92,8 +98,11 @@
function: rsUptimeNanos
ret: int64_t, "Uptime in nanoseconds."
-summary:
+summary: System uptime in nanoseconds
description:
Returns the current system clock (uptime) in nanoseconds.
+
+ The granularity of the values return by this call may be much
+ larger than a nanosecond.
test: none
end: