diff options
author | Tavian Barnes <tavianator@tavianator.com> | 2024-10-08 11:54:10 -0400 |
---|---|---|
committer | Tavian Barnes <tavianator@tavianator.com> | 2024-10-10 11:18:06 -0400 |
commit | 2889537ee68dacbdd9c8ea4e2053e03e86219c24 (patch) | |
tree | dba9bcb673ac93a0a30d2f1752797aaab2be9403 /src/xtime.h | |
parent | 271f6f44ea645c74f3130f03311b65e5dbdc7139 (diff) | |
download | bfs-2889537ee68dacbdd9c8ea4e2053e03e86219c24.tar.xz |
Adjust in/out parameter docs
Diffstat (limited to 'src/xtime.h')
-rw-r--r-- | src/xtime.h | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/xtime.h b/src/xtime.h index 7a1cf99..11f2bf9 100644 --- a/src/xtime.h +++ b/src/xtime.h @@ -13,9 +13,9 @@ /** * mktime() wrapper that reports errors more reliably. * - * @tm (in+out) - * The struct tm to convert. - * @timep (out) + * @tm[in,out] + * The struct tm to convert and normalize. + * @timep[out] * A pointer to the result. * @return * 0 on success, -1 on failure. @@ -25,9 +25,9 @@ int xmktime(struct tm *tm, time_t *timep); /** * A portable timegm(), the inverse of gmtime(). * - * @tm (in+out) - * The struct tm to convert. - * @timep (out) + * @tm[in,out] + * The struct tm to convert and normalize. + * @timep[out] * A pointer to the result. * @return * 0 on success, -1 on failure. @@ -39,7 +39,7 @@ int xtimegm(struct tm *tm, time_t *timep); * * @str * The string to parse. - * @result (out) + * @result[out] * A pointer to the result. * @return * 0 on success, -1 on failure. |