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/sighook.h | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

(limited to 'src/sighook.h')

diff --git a/src/sighook.h b/src/sighook.h
index 74d18c0..3bece21 100644
--- a/src/sighook.h
+++ b/src/sighook.h
@@ -27,11 +27,11 @@ enum sigflags {
  * A signal hook callback.  Hooks are executed from a signal handler, so must
  * only call async-signal-safe functions.
  *
- * @param sig
+ * @sig
  *         The signal number.
- * @param info
+ * @info
  *         Additional information about the signal.
- * @param arg
+ * @arg
  *         An arbitrary pointer passed to the hook.
  */
 typedef void sighook_fn(int sig, siginfo_t *info, void *arg);
@@ -39,13 +39,13 @@ typedef void sighook_fn(int sig, siginfo_t *info, void *arg);
 /**
  * Install a hook for a signal.
  *
- * @param sig
+ * @sig
  *         The signal to hook.
- * @param fn
+ * @fn
  *         The function to call.
- * @param arg
+ * @arg
  *         An argument passed to the function.
- * @param flags
+ * @flags
  *         Flags for the new hook.
  * @return
  *         The installed hook, or NULL on failure.
@@ -56,9 +56,9 @@ struct sighook *sighook(int sig, sighook_fn *fn, void *arg, enum sigflags flags)
  * On a best-effort basis, invoke the given hook just before the program is
  * abnormally terminated by a signal.
  *
- * @param fn
+ * @fn
  *         The function to call.
- * @param arg
+ * @arg
  *         An argument passed to the function.
  * @return
  *         The installed hook, or NULL on failure.
-- 
cgit v1.2.3