summaryrefslogtreecommitdiffstats
path: root/src/dir.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/dir.h
parente828c742de70ee18ccde87ffd7d28c99d999e7b2 (diff)
downloadbfs-9c9dc01f38c808948c6ea508503f913fa800bb9a.tar.xz
Write @arg instead of @param arg in doc comments
Diffstat (limited to 'src/dir.h')
-rw-r--r--src/dir.h18
1 files changed, 9 insertions, 9 deletions
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.