[clang-tidy] Fixed code sample in a comment. NFC
llvm-svn: 345984
This commit is contained in:
parent
a8eaaa8006
commit
3444cb9993
|
@ -25,16 +25,18 @@ namespace utils {
|
||||||
/// \brief Produces fixes to insert specified includes to source files, if not
|
/// \brief Produces fixes to insert specified includes to source files, if not
|
||||||
/// yet present.
|
/// yet present.
|
||||||
///
|
///
|
||||||
/// ``IncludeInserter`` can be used by ``ClangTidyCheck`` in the following
|
/// ``IncludeInserter`` can be used in clang-tidy checks in the following way:
|
||||||
/// fashion:
|
|
||||||
/// \code
|
/// \code
|
||||||
|
/// #include "../utils/IncludeInserter.h"
|
||||||
|
/// #include "clang/Frontend/CompilerInstance.h"
|
||||||
|
///
|
||||||
/// class MyCheck : public ClangTidyCheck {
|
/// class MyCheck : public ClangTidyCheck {
|
||||||
/// public:
|
/// public:
|
||||||
/// void registerPPCallbacks(CompilerInstance& Compiler) override {
|
/// void registerPPCallbacks(CompilerInstance& Compiler) override {
|
||||||
/// Inserter = llvm::make_unique<IncludeInserter>(&Compiler.getSourceManager(),
|
/// Inserter = llvm::make_unique<IncludeInserter>(&Compiler.getSourceManager(),
|
||||||
/// &Compiler.getLangOpts());
|
/// &Compiler.getLangOpts());
|
||||||
/// Compiler.getPreprocessor().addPPCallbacks(
|
/// Compiler.getPreprocessor().addPPCallbacks(
|
||||||
/// Inserter->CreatePPCallback());
|
/// Inserter->CreatePPCallbacks());
|
||||||
/// }
|
/// }
|
||||||
///
|
///
|
||||||
/// void registerMatchers(ast_matchers::MatchFinder* Finder) override { ... }
|
/// void registerMatchers(ast_matchers::MatchFinder* Finder) override { ... }
|
||||||
|
@ -49,7 +51,7 @@ namespace utils {
|
||||||
/// }
|
/// }
|
||||||
///
|
///
|
||||||
/// private:
|
/// private:
|
||||||
/// std::unique_ptr<IncludeInserter> Inserter;
|
/// std::unique_ptr<clang::tidy::utils::IncludeInserter> Inserter;
|
||||||
/// };
|
/// };
|
||||||
/// \endcode
|
/// \endcode
|
||||||
class IncludeInserter {
|
class IncludeInserter {
|
||||||
|
|
Loading…
Reference in New Issue