clang-tools 3.8.0

- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

TodoCommentCheck.h
Go to the documentation of this file.
1 //===--- TodoCommentCheck.h - clang-tidy ------------------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_TODOCOMMENTCHECK_H
11 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_TODOCOMMENTCHECK_H
12
13 #include "../ClangTidy.h"
14
15 namespace clang {
16 namespace tidy {
17 namespace google {
18 namespace readability {
19
20 /// Finds TODO comments without a username or bug number.
21 ///
22 /// Corresponding cpplint.py check: 'readability/todo'
23 class TodoCommentCheck : public ClangTidyCheck {
24 public:
25 TodoCommentCheck(StringRef Name, ClangTidyContext *Context);
26 void registerPPCallbacks(CompilerInstance &Compiler) override;
27
28 private:
29 class TodoCommentHandler;
30 std::unique_ptr<TodoCommentHandler> Handler;
31 };
32
33 } // namespace readability
34 } // namespace google
35 } // namespace tidy
36 } // namespace clang
37
38 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_TODOCOMMENTCHECK_H
Name
StringHandle Name
Definition: PreprocessorTracker.cpp:525
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidy.h:102
clang::tidy::google::readability::TodoCommentCheck::TodoCommentHandler
Definition: TodoCommentCheck.cpp:19
clang::tidy::google::readability::TodoCommentCheck
Finds TODO comments without a username or bug number.
Definition: TodoCommentCheck.h:23
clang::tidy::google::readability::TodoCommentCheck::TodoCommentCheck
TodoCommentCheck(StringRef Name, ClangTidyContext *Context)
Definition: TodoCommentCheck.cpp:54
Context
ClangTidyContext & Context
Definition: ClangTidy.cpp:93
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:124
clang::tidy::google::readability::TodoCommentCheck::registerPPCallbacks
void registerPPCallbacks(CompilerInstance &Compiler) override
Override this to register PPCallbacks with Compiler.
Definition: TodoCommentCheck.cpp:59