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 /lib/Tooling/Refactoring | |
parent | c8ad1ab42f269f29bcf6385446e5b728aff7e4ad (diff) |
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 'lib/Tooling/Refactoring')
-rw-r--r-- | lib/Tooling/Refactoring/AtomicChange.cpp | 6 | ||||
-rw-r--r-- | lib/Tooling/Refactoring/Extract/Extract.cpp | 2 | ||||
-rw-r--r-- | lib/Tooling/Refactoring/Rename/RenamingAction.cpp | 2 | ||||
-rw-r--r-- | lib/Tooling/Refactoring/Rename/USRFinder.cpp | 4 | ||||
-rw-r--r-- | lib/Tooling/Refactoring/Rename/USRFindingAction.cpp | 4 | ||||
-rw-r--r-- | lib/Tooling/Refactoring/Rename/USRLocFinder.cpp | 6 |
6 files changed, 12 insertions, 12 deletions
diff --git a/lib/Tooling/Refactoring/AtomicChange.cpp b/lib/Tooling/Refactoring/AtomicChange.cpp index e4cc6a5617..e8b0fdbeb6 100644 --- a/lib/Tooling/Refactoring/AtomicChange.cpp +++ b/lib/Tooling/Refactoring/AtomicChange.cpp @@ -15,7 +15,7 @@ LLVM_YAML_IS_SEQUENCE_VECTOR(clang::tooling::AtomicChange) namespace { -/// \brief Helper to (de)serialize an AtomicChange since we don't have direct +/// Helper to (de)serialize an AtomicChange since we don't have direct /// access to its data members. /// Data members of a normalized AtomicChange can be directly mapped from/to /// YAML string. @@ -50,7 +50,7 @@ struct NormalizedAtomicChange { namespace llvm { namespace yaml { -/// \brief Specialized MappingTraits to describe how an AtomicChange is +/// Specialized MappingTraits to describe how an AtomicChange is /// (de)serialized. template <> struct MappingTraits<NormalizedAtomicChange> { static void mapping(IO &Io, NormalizedAtomicChange &Doc) { @@ -63,7 +63,7 @@ template <> struct MappingTraits<NormalizedAtomicChange> { } }; -/// \brief Specialized MappingTraits to describe how an AtomicChange is +/// Specialized MappingTraits to describe how an AtomicChange is /// (de)serialized. template <> struct MappingTraits<clang::tooling::AtomicChange> { static void mapping(IO &Io, clang::tooling::AtomicChange &Doc) { diff --git a/lib/Tooling/Refactoring/Extract/Extract.cpp b/lib/Tooling/Refactoring/Extract/Extract.cpp index b0847a7400..a12454cd29 100644 --- a/lib/Tooling/Refactoring/Extract/Extract.cpp +++ b/lib/Tooling/Refactoring/Extract/Extract.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief Implements the "extract" refactoring that can pull code into +/// Implements the "extract" refactoring that can pull code into /// new functions, methods or declare new variables. /// //===----------------------------------------------------------------------===// diff --git a/lib/Tooling/Refactoring/Rename/RenamingAction.cpp b/lib/Tooling/Refactoring/Rename/RenamingAction.cpp index c8ed9dd19a..44ffae90ef 100644 --- a/lib/Tooling/Refactoring/Rename/RenamingAction.cpp +++ b/lib/Tooling/Refactoring/Rename/RenamingAction.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief Provides an action to rename every symbol at a point. +/// Provides an action to rename every symbol at a point. /// //===----------------------------------------------------------------------===// diff --git a/lib/Tooling/Refactoring/Rename/USRFinder.cpp b/lib/Tooling/Refactoring/Rename/USRFinder.cpp index 3bfb5bbe35..63f536c72a 100644 --- a/lib/Tooling/Refactoring/Rename/USRFinder.cpp +++ b/lib/Tooling/Refactoring/Rename/USRFinder.cpp @@ -32,7 +32,7 @@ namespace { class NamedDeclOccurrenceFindingVisitor : public RecursiveSymbolVisitor<NamedDeclOccurrenceFindingVisitor> { public: - // \brief Finds the NamedDecl at a point in the source. + // Finds the NamedDecl at a point in the source. // \param Point the location in the source to search for the NamedDecl. explicit NamedDeclOccurrenceFindingVisitor(const SourceLocation Point, const ASTContext &Context) @@ -58,7 +58,7 @@ public: const NamedDecl *getNamedDecl() const { return Result; } private: - // \brief Determines if the Point is within Start and End. + // Determines if the Point is within Start and End. bool isPointWithin(const SourceLocation Start, const SourceLocation End) { // FIXME: Add tests for Point == End. return Point == Start || Point == End || diff --git a/lib/Tooling/Refactoring/Rename/USRFindingAction.cpp b/lib/Tooling/Refactoring/Rename/USRFindingAction.cpp index 40b70d8a05..2e7c9b0cc3 100644 --- a/lib/Tooling/Refactoring/Rename/USRFindingAction.cpp +++ b/lib/Tooling/Refactoring/Rename/USRFindingAction.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief Provides an action to find USR for the symbol at <offset>, as well as +/// Provides an action to find USR for the symbol at <offset>, as well as /// all additional USRs. /// //===----------------------------------------------------------------------===// @@ -55,7 +55,7 @@ const NamedDecl *getCanonicalSymbolDeclaration(const NamedDecl *FoundDecl) { } namespace { -// \brief NamedDeclFindingConsumer should delegate finding USRs of given Decl to +// NamedDeclFindingConsumer should delegate finding USRs of given Decl to // AdditionalUSRFinder. AdditionalUSRFinder adds USRs of ctor and dtor if given // Decl refers to class and adds USRs of all overridden methods if Decl refers // to virtual method. diff --git a/lib/Tooling/Refactoring/Rename/USRLocFinder.cpp b/lib/Tooling/Refactoring/Rename/USRLocFinder.cpp index 56f32dd2ec..fb06b91118 100644 --- a/lib/Tooling/Refactoring/Rename/USRLocFinder.cpp +++ b/lib/Tooling/Refactoring/Rename/USRLocFinder.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief Methods for finding all instances of a USR. Our strategy is very +/// Methods for finding all instances of a USR. Our strategy is very /// simple; we just compare the USR at every relevant AST node with the one /// provided. /// @@ -50,7 +50,7 @@ bool IsValidEditLoc(const clang::SourceManager& SM, clang::SourceLocation Loc) { return SM.getFileEntryForID(FileIdAndOffset.first) != nullptr; } -// \brief This visitor recursively searches for all instances of a USR in a +// This visitor recursively searches for all instances of a USR in a // translation unit and stores them for later usage. class USRLocFindingASTVisitor : public RecursiveSymbolVisitor<USRLocFindingASTVisitor> { @@ -80,7 +80,7 @@ public: // Non-visitors: - /// \brief Returns a set of unique symbol occurrences. Duplicate or + /// Returns a set of unique symbol occurrences. Duplicate or /// overlapping occurrences are erroneous and should be reported! SymbolOccurrences takeOccurrences() { return std::move(Occurrences); } |