From 9c9dc01f38c808948c6ea508503f913fa800bb9a Mon Sep 17 00:00:00 2001
From: Tavian Barnes <tavianator@tavianator.com>
Date: Tue, 1 Oct 2024 10:58:17 -0400
Subject: Write @arg instead of @param arg in doc comments

---
 src/xregex.h | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

(limited to 'src/xregex.h')

diff --git a/src/xregex.h b/src/xregex.h
index 750db24..3bf3535 100644
--- a/src/xregex.h
+++ b/src/xregex.h
@@ -42,13 +42,13 @@ enum bfs_regexec_flags {
 /**
  * Wrapper for regcomp() that supports additional regex types.
  *
- * @param[out] preg
+ * @preg (out)
  *         Will hold the compiled regex.
- * @param pattern
+ * @pattern
  *         The regular expression to compile.
- * @param type
+ * @type
  *         The regular expression syntax to use.
- * @param flags
+ * @flags
  *         Regex compilation flags.
  * @return
  *         0 on success, -1 on failure.
@@ -58,11 +58,11 @@ int bfs_regcomp(struct bfs_regex **preg, const char *pattern, enum bfs_regex_typ
 /**
  * Wrapper for regexec().
  *
- * @param regex
+ * @regex
  *         The regular expression to execute.
- * @param str
+ * @str
  *         The string to match against.
- * @param flags
+ * @flags
  *         Regex execution flags.
  * @return
  *         1 for a match, 0 for no match, -1 on failure.
@@ -77,7 +77,7 @@ void bfs_regfree(struct bfs_regex *regex);
 /**
  * Get a human-readable regex error message.
  *
- * @param regex
+ * @regex
  *         The compiled regex.
  * @return
  *         A human-readable description of the error, which should be free()'d.
-- 
cgit v1.2.3