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

(limited to 'src/dir.h')

diff --git a/src/dir.h b/src/dir.h
index 4482003..0040b95 100644
--- a/src/dir.h
+++ b/src/dir.h
@@ -87,7 +87,7 @@ struct arena;
 /**
  * Initialize an arena for directories.
  *
- * @param arena
+ * @arena
  *         The arena to initialize.
  */
 void bfs_dir_arena(struct arena *arena);
@@ -105,14 +105,14 @@ enum bfs_dir_flags {
 /**
  * Open a directory.
  *
- * @param dir
+ * @dir
  *         The allocated directory.
- * @param at_fd
+ * @at_fd
  *         The base directory for path resolution.
- * @param at_path
+ * @at_path
  *         The path of the directory to open, relative to at_fd.  Pass NULL to
  *         open at_fd itself.
- * @param flags
+ * @flags
  *         Flags that control which directory entries are listed.
  * @return
  *         0 on success, or -1 on failure.
@@ -127,7 +127,7 @@ int bfs_dirfd(const struct bfs_dir *dir);
 /**
  * Performs any I/O necessary for the next bfs_readdir() call.
  *
- * @param dir
+ * @dir
  *         The directory to poll.
  * @return
  *         1 on success, 0 on EOF, or -1 on failure.
@@ -137,9 +137,9 @@ int bfs_polldir(struct bfs_dir *dir);
 /**
  * Read a directory entry.
  *
- * @param dir
+ * @dir
  *         The directory to read.
- * @param[out] dirent
+ * @dirent (out)
  *         The directory entry to populate.
  * @return
  *         1 on success, 0 on EOF, or -1 on failure.
@@ -165,7 +165,7 @@ int bfs_closedir(struct bfs_dir *dir);
 /**
  * Detach the file descriptor from an open directory.
  *
- * @param dir
+ * @dir
  *         The directory to detach.
  * @return
  *         The file descriptor of the directory.
-- 
cgit v1.2.3