clang-tools  14.0.0git
TodoCommentCheck.h
Go to the documentation of this file.
1 //===--- TodoCommentCheck.h - clang-tidy ------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_TODOCOMMENTCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_TODOCOMMENTCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace google {
17 namespace readability {
18 
19 /// Finds TODO comments without a username or bug number.
20 ///
21 /// Corresponding cpplint.py check: 'readability/todo'
22 ///
23 /// For the user-facing documentation see:
24 /// http://clang.llvm.org/extra/clang-tidy/checks/google-readability-todo.html
26 public:
27  TodoCommentCheck(StringRef Name, ClangTidyContext *Context);
29 
30  void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
31  Preprocessor *ModuleExpanderPP) override;
32 
33 private:
34  class TodoCommentHandler;
35  std::unique_ptr<TodoCommentHandler> Handler;
36 };
37 
38 } // namespace readability
39 } // namespace google
40 } // namespace tidy
41 } // namespace clang
42 
43 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_TODOCOMMENTCHECK_H
clang::tidy::google::readability::TodoCommentCheck
Finds TODO comments without a username or bug number.
Definition: TodoCommentCheck.h:25
clang::tidy::google::readability::TodoCommentCheck::registerPPCallbacks
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
Override this to register PPCallbacks in the preprocessor.
Definition: TodoCommentCheck.cpp:60
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::google::readability::TodoCommentCheck::TodoCommentCheck
TodoCommentCheck(StringRef Name, ClangTidyContext *Context)
Definition: TodoCommentCheck.cpp:53
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:71
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::bugprone::PP
static Preprocessor * PP
Definition: BadSignalToKillThreadCheck.cpp:29
clang::tidy::google::readability::TodoCommentCheck::~TodoCommentCheck
~TodoCommentCheck()
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::google::readability::TodoCommentCheck::TodoCommentHandler
Definition: TodoCommentCheck.cpp:18
SM
const SourceManager & SM
Definition: IncludeCleaner.cpp:140