summaryrefslogtreecommitdiffstats
path: root/src/sighook.h
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@tavianator.com>2024-10-01 10:58:17 -0400
committerTavian Barnes <tavianator@tavianator.com>2024-10-01 11:04:29 -0400
commit9c9dc01f38c808948c6ea508503f913fa800bb9a (patch)
treef9097e22108c24e0f47396e13576145460b65214 /src/sighook.h
parente828c742de70ee18ccde87ffd7d28c99d999e7b2 (diff)
downloadbfs-9c9dc01f38c808948c6ea508503f913fa800bb9a.tar.xz
Write @arg instead of @param arg in doc comments
Diffstat (limited to 'src/sighook.h')
-rw-r--r--src/sighook.h18
1 files changed, 9 insertions, 9 deletions
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.