diff options
| author | Adrian Prantl <aprantl@apple.com> | 2018-05-01 16:10:38 +0000 |
|---|---|---|
| committer | Adrian Prantl <aprantl@apple.com> | 2018-05-01 16:10:38 +0000 |
| commit | 4dfcc4a7882f5e6d6e66d3c535c01edb3c56053d (patch) | |
| tree | c977b96be3795f8453239a86b93890394310a2cb /llvm/tools | |
| parent | 661e6a02bdfe7c98dc108bfecca2c2a0cd1b5614 (diff) | |
| download | bcm5719-llvm-4dfcc4a7882f5e6d6e66d3c535c01edb3c56053d.tar.gz bcm5719-llvm-4dfcc4a7882f5e6d6e66d3c535c01edb3c56053d.zip | |
Remove @brief commands from doxygen comments, too.
This is a follow-up to r331272.
We've been running doxygen with the autobrief option for a couple of
years now. This makes the \brief markers into our comments
redundant. Since they are a visual distraction and we don't want to
encourage more \brief markers in new code either, this patch removes
them all.
Patch produced by
for i in $(git grep -l '\@brief'); do perl -pi -e 's/\@brief //g' $i & done
https://reviews.llvm.org/D46290
llvm-svn: 331275
Diffstat (limited to 'llvm/tools')
| -rw-r--r-- | llvm/tools/bugpoint/ToolRunner.cpp | 2 | ||||
| -rw-r--r-- | llvm/tools/llvm-objdump/llvm-objdump.cpp | 6 | ||||
| -rw-r--r-- | llvm/tools/llvm-readobj/llvm-readobj.cpp | 12 |
3 files changed, 10 insertions, 10 deletions
diff --git a/llvm/tools/bugpoint/ToolRunner.cpp b/llvm/tools/bugpoint/ToolRunner.cpp index 20eb738bd51..ea0128d0e82 100644 --- a/llvm/tools/bugpoint/ToolRunner.cpp +++ b/llvm/tools/bugpoint/ToolRunner.cpp @@ -215,7 +215,7 @@ const char EXESuffix[] = "exe"; /// itself. This allows us to find another LLVM tool if it is built in the same /// directory. An empty string is returned on error; note that this function /// just mainpulates the path and doesn't check for executability. -/// @brief Find a named executable. +/// Find a named executable. static std::string PrependMainExecutablePath(const std::string &ExeName, const char *Argv0, void *MainAddr) { diff --git a/llvm/tools/llvm-objdump/llvm-objdump.cpp b/llvm/tools/llvm-objdump/llvm-objdump.cpp index 0a1f0e2cda7..ce2bd1092be 100644 --- a/llvm/tools/llvm-objdump/llvm-objdump.cpp +++ b/llvm/tools/llvm-objdump/llvm-objdump.cpp @@ -1129,7 +1129,7 @@ static std::error_code getRelocationValueString(const RelocationRef &Rel, llvm_unreachable("unknown object file format"); } -/// @brief Indicates whether this relocation should hidden when listing +/// Indicates whether this relocation should hidden when listing /// relocations, usually because it is the trailing part of a multipart /// relocation that will be printed as part of the leading relocation. static bool getHidden(RelocationRef RelRef) { @@ -2149,7 +2149,7 @@ static void DumpObject(const COFFImportFile *I, const Archive *A) { printCOFFSymbolTable(I); } -/// @brief Dump each object file in \a a; +/// Dump each object file in \a a; static void DumpArchive(const Archive *a) { Error Err = Error::success(); for (auto &C : a->children(Err)) { @@ -2170,7 +2170,7 @@ static void DumpArchive(const Archive *a) { report_error(a->getFileName(), std::move(Err)); } -/// @brief Open file and figure out how to dump it. +/// Open file and figure out how to dump it. static void DumpInput(StringRef file) { // If we are using the Mach-O specific object file parser, then let it parse diff --git a/llvm/tools/llvm-readobj/llvm-readobj.cpp b/llvm/tools/llvm-readobj/llvm-readobj.cpp index 2ff92a0a21f..4b8a1b32471 100644 --- a/llvm/tools/llvm-readobj/llvm-readobj.cpp +++ b/llvm/tools/llvm-readobj/llvm-readobj.cpp @@ -359,7 +359,7 @@ struct ReadObjTypeTableBuilder { } static ReadObjTypeTableBuilder CVTypes; -/// @brief Creates an format-specific object file dumper. +/// Creates an format-specific object file dumper. static std::error_code createDumper(const ObjectFile *Obj, ScopedPrinter &Writer, std::unique_ptr<ObjDumper> &Result) { @@ -378,7 +378,7 @@ static std::error_code createDumper(const ObjectFile *Obj, return readobj_error::unsupported_obj_file_format; } -/// @brief Dumps the specified object file. +/// Dumps the specified object file. static void dumpObject(const ObjectFile *Obj, ScopedPrinter &Writer) { std::unique_ptr<ObjDumper> Dumper; if (std::error_code EC = createDumper(Obj, Writer, Dumper)) @@ -482,7 +482,7 @@ static void dumpObject(const ObjectFile *Obj, ScopedPrinter &Writer) { Dumper->printStackMap(); } -/// @brief Dumps each object file in \a Arc; +/// Dumps each object file in \a Arc; static void dumpArchive(const Archive *Arc, ScopedPrinter &Writer) { Error Err = Error::success(); for (auto &Child : Arc->children(Err)) { @@ -504,7 +504,7 @@ static void dumpArchive(const Archive *Arc, ScopedPrinter &Writer) { reportError(Arc->getFileName(), std::move(Err)); } -/// @brief Dumps each object file in \a MachO Universal Binary; +/// Dumps each object file in \a MachO Universal Binary; static void dumpMachOUniversalBinary(const MachOUniversalBinary *UBinary, ScopedPrinter &Writer) { for (const MachOUniversalBinary::ObjectForArch &Obj : UBinary->objects()) { @@ -519,7 +519,7 @@ static void dumpMachOUniversalBinary(const MachOUniversalBinary *UBinary, } } -/// @brief Dumps \a WinRes, Windows Resource (.res) file; +/// Dumps \a WinRes, Windows Resource (.res) file; static void dumpWindowsResourceFile(WindowsResource *WinRes) { ScopedPrinter Printer{outs()}; WindowsRes::Dumper Dumper(WinRes, Printer); @@ -528,7 +528,7 @@ static void dumpWindowsResourceFile(WindowsResource *WinRes) { } -/// @brief Opens \a File and dumps it. +/// Opens \a File and dumps it. static void dumpInput(StringRef File) { ScopedPrinter Writer(outs()); |

