diff options
Diffstat (limited to 'contrib/apr/include/apr_time.h')
| -rw-r--r-- | contrib/apr/include/apr_time.h | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/contrib/apr/include/apr_time.h b/contrib/apr/include/apr_time.h index 6dd70cc..15e0b96 100644 --- a/contrib/apr/include/apr_time.h +++ b/contrib/apr/include/apr_time.h @@ -42,7 +42,7 @@ APR_DECLARE_DATA extern const char apr_month_snames[12][4]; APR_DECLARE_DATA extern const char apr_day_snames[7][4]; -/** number of microseconds since 00:00:00 january 1, 1970 UTC */ +/** number of microseconds since 00:00:00 January 1, 1970 UTC */ typedef apr_int64_t apr_time_t; @@ -93,7 +93,7 @@ typedef struct apr_time_exp_t apr_time_exp_t; /** * a structure similar to ANSI struct tm with the following differences: * - tm_usec isn't an ANSI field - * - tm_gmtoff isn't an ANSI field (it's a bsdism) + * - tm_gmtoff isn't an ANSI field (it's a BSDism) */ struct apr_time_exp_t { /** microseconds past tm_sec */ @@ -110,9 +110,9 @@ struct apr_time_exp_t { apr_int32_t tm_mon; /** year since 1900 */ apr_int32_t tm_year; - /** (0-6) days since sunday */ + /** (0-6) days since Sunday */ apr_int32_t tm_wday; - /** (0-365) days since jan 1 */ + /** (0-365) days since January 1 */ apr_int32_t tm_yday; /** daylight saving time */ apr_int32_t tm_isdst; @@ -121,7 +121,7 @@ struct apr_time_exp_t { }; /** - * convert an ansi time_t to an apr_time_t + * Convert an ansi time_t to an apr_time_t * @param result the resulting apr_time_t * @param input the time_t to convert */ @@ -129,8 +129,8 @@ APR_DECLARE(apr_status_t) apr_time_ansi_put(apr_time_t *result, time_t input); /** - * convert a time to its human readable components using an offset - * from GMT + * Convert a time to its human readable components using an offset + * from GMT. * @param result the exploded time * @param input the time to explode * @param offs the number of seconds offset to apply @@ -140,7 +140,7 @@ APR_DECLARE(apr_status_t) apr_time_exp_tz(apr_time_exp_t *result, apr_int32_t offs); /** - * convert a time to its human readable components in GMT timezone + * Convert a time to its human readable components (GMT). * @param result the exploded time * @param input the time to explode */ @@ -148,7 +148,7 @@ APR_DECLARE(apr_status_t) apr_time_exp_gmt(apr_time_exp_t *result, apr_time_t input); /** - * convert a time to its human readable components in local timezone + * Convert a time to its human readable components in the local timezone. * @param result the exploded time * @param input the time to explode */ @@ -156,8 +156,8 @@ APR_DECLARE(apr_status_t) apr_time_exp_lt(apr_time_exp_t *result, apr_time_t input); /** - * Convert time value from human readable format to a numeric apr_time_t - * e.g. elapsed usec since epoch + * Convert time value from human readable format to a numeric apr_time_t + * (elapsed microseconds since the epoch). * @param result the resulting imploded time * @param input the input exploded time */ @@ -166,7 +166,7 @@ APR_DECLARE(apr_status_t) apr_time_exp_get(apr_time_t *result, /** * Convert time value from human readable format to a numeric apr_time_t that - * always represents GMT + * always represents GMT. * @param result the resulting imploded time * @param input the input exploded time */ @@ -185,7 +185,7 @@ APR_DECLARE(void) apr_sleep(apr_interval_time_t t); /** * apr_rfc822_date formats dates in the RFC822 * format in an efficient manner. It is a fixed length - * format which requires the indicated amount of storage, + * format which requires APR_RFC822_DATA_LEN bytes of storage, * including the trailing NUL terminator. * @param date_str String to write to. * @param t the time to convert @@ -196,18 +196,18 @@ APR_DECLARE(apr_status_t) apr_rfc822_date(char *date_str, apr_time_t t); #define APR_CTIME_LEN (25) /** * apr_ctime formats dates in the ctime() format - * in an efficient manner. it is a fixed length format - * and requires the indicated amount of storage including + * in an efficient manner. It is a fixed length format + * and requires APR_CTIME_LEN bytes of storage including * the trailing NUL terminator. * Unlike ANSI/ISO C ctime(), apr_ctime() does not include - * a \n at the end of the string. + * a \\n at the end of the string. * @param date_str String to write to. * @param t the time to convert */ APR_DECLARE(apr_status_t) apr_ctime(char *date_str, apr_time_t t); /** - * formats the exploded time according to the format specified + * Formats the exploded time according to the format specified * @param s string to write to * @param retsize The length of the returned string * @param max The maximum length of the string @@ -220,7 +220,7 @@ APR_DECLARE(apr_status_t) apr_strftime(char *s, apr_size_t *retsize, /** * Improve the clock resolution for the lifetime of the given pool. - * Generally this is only desireable on benchmarking and other very + * Generally this is only desirable on benchmarking and other very * time-sensitive applications, and has no impact on most platforms. * @param p The pool to associate the finer clock resolution */ |
