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 /include/clang/Tooling/Refactoring.h | |
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 'include/clang/Tooling/Refactoring.h')
-rw-r--r-- | include/clang/Tooling/Refactoring.h | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/include/clang/Tooling/Refactoring.h b/include/clang/Tooling/Refactoring.h index bc95c3b09e..64b018ea26 100644 --- a/include/clang/Tooling/Refactoring.h +++ b/include/clang/Tooling/Refactoring.h @@ -30,7 +30,7 @@ class Rewriter; namespace tooling { -/// \brief A tool to run refactorings. +/// A tool to run refactorings. /// /// This is a refactoring specific version of \see ClangTool. FrontendActions /// passed to run() and runAndSave() should add replacements to @@ -43,17 +43,17 @@ public: std::shared_ptr<PCHContainerOperations> PCHContainerOps = std::make_shared<PCHContainerOperations>()); - /// \brief Returns the file path to replacements map to which replacements + /// Returns the file path to replacements map to which replacements /// should be added during the run of the tool. std::map<std::string, Replacements> &getReplacements(); - /// \brief Call run(), apply all generated replacements, and immediately save + /// Call run(), apply all generated replacements, and immediately save /// the results to disk. /// /// \returns 0 upon success. Non-zero upon failure. int runAndSave(FrontendActionFactory *ActionFactory); - /// \brief Apply all stored replacements to the given Rewriter. + /// Apply all stored replacements to the given Rewriter. /// /// FileToReplaces will be deduplicated with `groupReplacementsByFile` before /// application. @@ -65,14 +65,14 @@ public: bool applyAllReplacements(Rewriter &Rewrite); private: - /// \brief Write all refactored files to disk. + /// Write all refactored files to disk. int saveRewrittenFiles(Rewriter &Rewrite); private: std::map<std::string, Replacements> FileToReplaces; }; -/// \brief Groups \p Replaces by the file path and applies each group of +/// Groups \p Replaces by the file path and applies each group of /// Replacements on the related file in \p Rewriter. In addition to applying /// given Replacements, this function also formats the changed code. /// |