Standardization of some function headers.

This commit is contained in:
Gregory Nutt
2018-03-13 09:52:27 -06:00
parent c268288c17
commit b54ffe858a
488 changed files with 2008 additions and 2007 deletions
+1 -1
View File
@@ -84,7 +84,7 @@ static long compare_timespec(FAR const struct timespec *a,
* Description:
* Convert an absolute timespec delay to system timer ticks.
*
* Parameters:
* Input Parameters:
* clockid - The timing source to use in the conversion
* reltime - Convert this absolue time to system clock ticks.
* ticks - Return the converted number of ticks here.
+1 -1
View File
@@ -65,7 +65,7 @@ static const uint8_t g_lookup[12] = {2, 5, 7, 10, 12, 15, 17, 20, 23, 25, 28, 30
* an algorithm pubished in 1990 by Michael Keith and Tom Craver with some
* tweaks to handle months in the range 0-11.
*
* Parameters:
* Input Parameters:
* year - year (e.g., 1988)
* month - 0 through 11
* day - 1 through 31
+2 -2
View File
@@ -263,7 +263,7 @@ void clock_initialize(void)
* Time going backward could have bad consequences if there are ongoing
* timers and delays. So use this interface with care.
*
* Parameters:
* Input Parameters:
* None
*
* Returned Value:
@@ -302,7 +302,7 @@ void clock_synchronize(void)
* time. If setting system time with RTC would result time going "backward"
* then resynchronization is not performed.
*
* Parameters:
* Input Parameters:
* rtc_diff: amount of time system-time is adjusted forward with RTC
*
* Returned Value:
+1 -1
View File
@@ -69,7 +69,7 @@
* Description:
* Return the current value of the 32/64-bit system timer counter
*
* Parameters:
* Input Parameters:
* None
*
* Returned Value:
+1 -1
View File
@@ -59,7 +59,7 @@
* Return the current value of the system timer counter as a struct
* timespec. The returned time is the elapsed time since power up.
*
* Parameters:
* Input Parameters:
* ts - Location to return the time
*
* Returned Value:
+1 -1
View File
@@ -52,7 +52,7 @@
* Description:
* Convert the system time tick value to a relative time.
*
* Parameters:
* Input Parameters:
* ticks - The number of system time ticks to convert.
* reltime - Return the converted system time here.
*
+1 -1
View File
@@ -56,7 +56,7 @@
* suitable for calculating relative time delays and does not depend on
* the other clock_* logic.
*
* Parameters:
* Input Parameters:
* reltime - Convert this relative time to system clock ticks.
* ticks - Return the converted number of ticks here.
*