Remove redundant @-style doc comment tags (#1641)

This commit is contained in:
Rangi
2025-01-29 19:56:28 -05:00
committed by GitHub
parent e20347e38c
commit b35e9d86fb
14 changed files with 50 additions and 144 deletions

View File

@@ -270,8 +270,7 @@ static void registerInput(char const *arg) {
}
}
// Turn an "at-file"'s contents into an argv that `getopt` can handle
// @param argPool Argument characters will be appended to this vector, for storage purposes.
// Turn an at-file's contents into an argv that `getopt` can handle, appending them to `argPool`.
static std::vector<size_t> readAtFile(std::string const &path, std::vector<char> &argPool) {
File file;
if (!file.open(path, std::ios_base::in)) {

View File

@@ -189,8 +189,8 @@ static T readLE(U const *bytes) {
return val;
}
// **Appends** the first line read from `file` to the end of the provided `buffer`.
// @return true if a line was read.
// Appends the first line read from `file` to the end of the provided `buffer`.
// Returns true if a line was read.
[[gnu::warn_unused_result]]
static bool readLine(std::filebuf &file, std::string &buffer) {
assume(buffer.empty());