summaryrefslogtreecommitdiffstats
path: root/src/stat.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/stat.h
parente828c742de70ee18ccde87ffd7d28c99d999e7b2 (diff)
downloadbfs-9c9dc01f38c808948c6ea508503f913fa800bb9a.tar.xz
Write @arg instead of @param arg in doc comments
Diffstat (limited to 'src/stat.h')
-rw-r--r--src/stat.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/stat.h b/src/stat.h
index 8d0bd9b..6adeb52 100644
--- a/src/stat.h
+++ b/src/stat.h
@@ -119,14 +119,14 @@ struct bfs_stat {
/**
* Facade over fstatat().
*
- * @param at_fd
+ * @at_fd
* The base file descriptor for the lookup.
- * @param at_path
+ * @at_path
* The path to stat, relative to at_fd. Pass NULL to fstat() at_fd
* itself.
- * @param flags
+ * @flags
* Flags that affect the lookup.
- * @param[out] buf
+ * @buf (out)
* A place to store the stat buffer, if successful.
* @return
* 0 on success, -1 on error.