diff options
author | Adrian Prantl <aprantl@apple.com> | 2018-05-09 01:00:01 +0000 |
---|---|---|
committer | Adrian Prantl <aprantl@apple.com> | 2018-05-09 01:00:01 +0000 |
commit | 647be32c6048e24f90f470c557e850597e5526c3 (patch) | |
tree | 2be5c01566ec82e55fd30ceedef970efd887b4a5 /utils | |
parent | c8ad1ab42f269f29bcf6385446e5b728aff7e4ad (diff) | |
download | clang-647be32c6048e24f90f470c557e850597e5526c3.tar.gz |
Remove \brief commands from doxygen comments.
This is similar to the LLVM change https://reviews.llvm.org/D46290.
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
for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done
Differential Revision: https://reviews.llvm.org/D46320
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@331834 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'utils')
-rw-r--r-- | utils/TableGen/ClangAttrEmitter.cpp | 6 | ||||
-rw-r--r-- | utils/TableGen/ClangCommentHTMLNamedCharacterReferenceEmitter.cpp | 2 | ||||
-rw-r--r-- | utils/TableGen/ClangDiagnosticsEmitter.cpp | 14 | ||||
-rw-r--r-- | utils/TableGen/ClangSACheckersEmitter.cpp | 2 |
4 files changed, 12 insertions, 12 deletions
diff --git a/utils/TableGen/ClangAttrEmitter.cpp b/utils/TableGen/ClangAttrEmitter.cpp index 19a97f7d6c..712a854627 100644 --- a/utils/TableGen/ClangAttrEmitter.cpp +++ b/utils/TableGen/ClangAttrEmitter.cpp @@ -1507,7 +1507,7 @@ writePrettyPrintFunction(Record &R, OS << "}\n\n"; } -/// \brief Return the index of a spelling in a spelling list. +/// Return the index of a spelling in a spelling list. static unsigned getSpellingListIndex(const std::vector<FlattenedSpelling> &SpellingList, const FlattenedSpelling &Spelling) { @@ -2056,7 +2056,7 @@ static void forEachUniqueSpelling(const Record &Attr, Fn &&F) { } } -/// \brief Emits the first-argument-is-type property for attributes. +/// Emits the first-argument-is-type property for attributes. static void emitClangAttrTypeArgList(RecordKeeper &Records, raw_ostream &OS) { OS << "#if defined(CLANG_ATTR_TYPE_ARG_LIST)\n"; std::vector<Record *> Attrs = Records.getAllDerivedDefinitions("Attr"); @@ -2078,7 +2078,7 @@ static void emitClangAttrTypeArgList(RecordKeeper &Records, raw_ostream &OS) { OS << "#endif // CLANG_ATTR_TYPE_ARG_LIST\n\n"; } -/// \brief Emits the parse-arguments-in-unevaluated-context property for +/// Emits the parse-arguments-in-unevaluated-context property for /// attributes. static void emitClangAttrArgContextList(RecordKeeper &Records, raw_ostream &OS) { OS << "#if defined(CLANG_ATTR_ARG_CONTEXT_LIST)\n"; diff --git a/utils/TableGen/ClangCommentHTMLNamedCharacterReferenceEmitter.cpp b/utils/TableGen/ClangCommentHTMLNamedCharacterReferenceEmitter.cpp index bfdb268b63..bea97ae132 100644 --- a/utils/TableGen/ClangCommentHTMLNamedCharacterReferenceEmitter.cpp +++ b/utils/TableGen/ClangCommentHTMLNamedCharacterReferenceEmitter.cpp @@ -22,7 +22,7 @@ using namespace llvm; -/// \brief Convert a code point to the corresponding UTF-8 sequence represented +/// Convert a code point to the corresponding UTF-8 sequence represented /// as a C string literal. /// /// \returns true on success. diff --git a/utils/TableGen/ClangDiagnosticsEmitter.cpp b/utils/TableGen/ClangDiagnosticsEmitter.cpp index a8a56df75e..634594647e 100644 --- a/utils/TableGen/ClangDiagnosticsEmitter.cpp +++ b/utils/TableGen/ClangDiagnosticsEmitter.cpp @@ -154,7 +154,7 @@ static bool beforeThanCompareGroups(const GroupInfo *LHS, const GroupInfo *RHS){ RHS->DiagsInGroup.front()); } -/// \brief Invert the 1-[0/1] mapping of diags to group into a one to many +/// Invert the 1-[0/1] mapping of diags to group into a one to many /// mapping of groups to diags in the group. static void groupDiagnostics(const std::vector<Record*> &Diags, const std::vector<Record*> &DiagGroups, @@ -572,7 +572,7 @@ static std::string getDiagCategoryEnum(llvm::StringRef name) { return enumName.str(); } -/// \brief Emit the array of diagnostic subgroups. +/// Emit the array of diagnostic subgroups. /// /// The array of diagnostic subgroups contains for each group a list of its /// subgroups. The individual lists are separated by '-1'. Groups with no @@ -619,7 +619,7 @@ static void emitDiagSubGroups(std::map<std::string, GroupInfo> &DiagsInGroup, OS << "};\n\n"; } -/// \brief Emit the list of diagnostic arrays. +/// Emit the list of diagnostic arrays. /// /// This data structure is a large array that contains itself arrays of varying /// size. Each array represents a list of diagnostics. The different arrays are @@ -660,7 +660,7 @@ static void emitDiagArrays(std::map<std::string, GroupInfo> &DiagsInGroup, OS << "};\n\n"; } -/// \brief Emit a list of group names. +/// Emit a list of group names. /// /// This creates a long string which by itself contains a list of pascal style /// strings, which consist of a length byte directly followed by the string. @@ -677,7 +677,7 @@ static void emitDiagGroupNames(StringToOffsetTable &GroupNames, OS << "};\n\n"; } -/// \brief Emit diagnostic arrays and related data structures. +/// Emit diagnostic arrays and related data structures. /// /// This creates the actual diagnostic array, an array of diagnostic subgroups /// and an array of subgroup names. @@ -701,7 +701,7 @@ static void emitAllDiagArrays(std::map<std::string, GroupInfo> &DiagsInGroup, OS << "#endif // GET_DIAG_ARRAYS\n\n"; } -/// \brief Emit diagnostic table. +/// Emit diagnostic table. /// /// The table is sorted by the name of the diagnostic group. Each element /// consists of the name of the diagnostic group (given as offset in the @@ -776,7 +776,7 @@ static void emitDiagTable(std::map<std::string, GroupInfo> &DiagsInGroup, OS << "#endif // GET_DIAG_TABLE\n\n"; } -/// \brief Emit the table of diagnostic categories. +/// Emit the table of diagnostic categories. /// /// The table has the form of macro calls that have two parameters. The /// category's name as well as an enum that represents the category. The diff --git a/utils/TableGen/ClangSACheckersEmitter.cpp b/utils/TableGen/ClangSACheckersEmitter.cpp index 8f3de0b67d..4fda8e47e4 100644 --- a/utils/TableGen/ClangSACheckersEmitter.cpp +++ b/utils/TableGen/ClangSACheckersEmitter.cpp @@ -23,7 +23,7 @@ using namespace llvm; // Static Analyzer Checkers Tables generation //===----------------------------------------------------------------------===// -/// \brief True if it is specified hidden or a parent package is specified +/// True if it is specified hidden or a parent package is specified /// as hidden, otherwise false. static bool isHidden(const Record &R) { if (R.getValueAsBit("Hidden")) |