diff options
| author | Tavian Barnes <tavianator@tavianator.com> | 2024-10-01 10:58:17 -0400 |
|---|---|---|
| committer | Tavian Barnes <tavianator@tavianator.com> | 2024-10-01 11:04:29 -0400 |
| commit | 9c9dc01f38c808948c6ea508503f913fa800bb9a (patch) | |
| tree | f9097e22108c24e0f47396e13576145460b65214 /src/color.h | |
| parent | e828c742de70ee18ccde87ffd7d28c99d999e7b2 (diff) | |
| download | bfs-9c9dc01f38c808948c6ea508503f913fa800bb9a.tar.xz | |
Write @arg instead of @param arg in doc comments
Diffstat (limited to 'src/color.h')
| -rw-r--r-- | src/color.h | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/src/color.h b/src/color.h index 38f5ad7..2394af2 100644 --- a/src/color.h +++ b/src/color.h @@ -54,11 +54,11 @@ typedef struct CFILE { /** * Wrap an existing file into a colored stream. * - * @param file + * @file * The underlying file. - * @param colors + * @colors * The color table to use if file is a TTY. - * @param close + * @close * Whether to close the underlying stream when this stream is closed. * @return * A colored wrapper around file. @@ -68,7 +68,7 @@ CFILE *cfwrap(FILE *file, const struct colors *colors, bool close); /** * Close a colored file. * - * @param cfile + * @cfile * The colored file to close. * @return * 0 on success, -1 on failure. @@ -78,9 +78,9 @@ int cfclose(CFILE *cfile); /** * Colored, formatted output. * - * @param cfile + * @cfile * The colored stream to print to. - * @param format + * @format * A printf()-style format string, supporting these format specifiers: * * %c: A single character |