summaryrefslogtreecommitdiffstats
path: root/clang-tools-extra/clang-tidy/ClangTidyModule.h
diff options
context:
space:
mode:
authorDmitri Gribenko <gribozavr@gmail.com>2019-08-22 11:32:57 +0000
committerDmitri Gribenko <gribozavr@gmail.com>2019-08-22 11:32:57 +0000
commit282dc72c8b84759dda4fe12420228158962351e8 (patch)
treeffcad792c5d71d8ebe53a15b65b154dbd0a50528 /clang-tools-extra/clang-tidy/ClangTidyModule.h
parentc6744055adf950b8deaa0291cb475d70ca292740 (diff)
downloadbcm5719-llvm-282dc72c8b84759dda4fe12420228158962351e8.tar.gz
bcm5719-llvm-282dc72c8b84759dda4fe12420228158962351e8.zip
Remove \brief commands from doxygen comments.
Summary: 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 [This is analogous to LLVM r331272 and CFE r331834] Subscribers: srhines, nemanjai, javed.absar, kbarton, MaskRay, jkorous, arphaman, jfb, kadircet, jsji, cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D66578 llvm-svn: 369643
Diffstat (limited to 'clang-tools-extra/clang-tidy/ClangTidyModule.h')
-rw-r--r--clang-tools-extra/clang-tidy/ClangTidyModule.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/clang-tools-extra/clang-tidy/ClangTidyModule.h b/clang-tools-extra/clang-tidy/ClangTidyModule.h
index 378f1093e2f..894093d95b9 100644
--- a/clang-tools-extra/clang-tidy/ClangTidyModule.h
+++ b/clang-tools-extra/clang-tidy/ClangTidyModule.h
@@ -19,7 +19,7 @@
namespace clang {
namespace tidy {
-/// \brief A collection of \c ClangTidyCheckFactory instances.
+/// A collection of \c ClangTidyCheckFactory instances.
///
/// All clang-tidy modules register their check factories with an instance of
/// this object.
@@ -29,12 +29,12 @@ public:
ClangTidyContext *Context)>
CheckFactory;
- /// \brief Registers check \p Factory with name \p Name.
+ /// Registers check \p Factory with name \p Name.
///
/// For all checks that have default constructors, use \c registerCheck.
void registerCheckFactory(StringRef Name, CheckFactory Factory);
- /// \brief Registers the \c CheckType with the name \p Name.
+ /// Registers the \c CheckType with the name \p Name.
///
/// This method should be used for all \c ClangTidyChecks that don't require
/// constructor parameters.
@@ -62,7 +62,7 @@ public:
});
}
- /// \brief Create instances of all checks matching \p CheckRegexString and
+ /// Create instances of all checks matching \p CheckRegexString and
/// store them in \p Checks.
///
/// The caller takes ownership of the return \c ClangTidyChecks.
@@ -78,17 +78,17 @@ private:
FactoryMap Factories;
};
-/// \brief A clang-tidy module groups a number of \c ClangTidyChecks and gives
+/// A clang-tidy module groups a number of \c ClangTidyChecks and gives
/// them a prefixed name.
class ClangTidyModule {
public:
virtual ~ClangTidyModule() {}
- /// \brief Implement this function in order to register all \c CheckFactories
+ /// Implement this function in order to register all \c CheckFactories
/// belonging to this module.
virtual void addCheckFactories(ClangTidyCheckFactories &CheckFactories) = 0;
- /// \brief Gets default options for checks defined in this module.
+ /// Gets default options for checks defined in this module.
virtual ClangTidyOptions getModuleOptions();
};
OpenPOWER on IntegriCloud