From 2889537ee68dacbdd9c8ea4e2053e03e86219c24 Mon Sep 17 00:00:00 2001
From: Tavian Barnes <tavianator@tavianator.com>
Date: Tue, 8 Oct 2024 11:54:10 -0400
Subject: Adjust in/out parameter docs

---
 src/color.c  |  2 +-
 src/dir.h    |  2 +-
 src/stat.h   |  2 +-
 src/xregex.h |  2 +-
 src/xtime.h  | 14 +++++++-------
 5 files changed, 11 insertions(+), 11 deletions(-)

(limited to 'src')

diff --git a/src/color.c b/src/color.c
index 0885726..d1b36f9 100644
--- a/src/color.c
+++ b/src/color.c
@@ -434,7 +434,7 @@ static const struct esc_seq *get_ext(const struct colors *colors, const char *fi
  *         The value to parse.
  * @end
  *         The character that marks the end of the chunk.
- * @next (out)
+ * @next[out]
  *         Will be set to the next chunk.
  * @return
  *         0 on success, -1 on failure.
diff --git a/src/dir.h b/src/dir.h
index 35a459d..885dac3 100644
--- a/src/dir.h
+++ b/src/dir.h
@@ -141,7 +141,7 @@ int bfs_polldir(struct bfs_dir *dir);
  *
  * @dir
  *         The directory to read.
- * @dirent (out)
+ * @dirent[out]
  *         The directory entry to populate.
  * @return
  *         1 on success, 0 on EOF, or -1 on failure.
diff --git a/src/stat.h b/src/stat.h
index 6adeb52..50c91de 100644
--- a/src/stat.h
+++ b/src/stat.h
@@ -126,7 +126,7 @@ struct bfs_stat {
  *         itself.
  * @flags
  *         Flags that affect the lookup.
- * @buf (out)
+ * @buf[out]
  *         A place to store the stat buffer, if successful.
  * @return
  *         0 on success, -1 on error.
diff --git a/src/xregex.h b/src/xregex.h
index 3bf3535..c4504ee 100644
--- a/src/xregex.h
+++ b/src/xregex.h
@@ -42,7 +42,7 @@ enum bfs_regexec_flags {
 /**
  * Wrapper for regcomp() that supports additional regex types.
  *
- * @preg (out)
+ * @preg[out]
  *         Will hold the compiled regex.
  * @pattern
  *         The regular expression to compile.
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.
-- 
cgit v1.2.3