clang-tools  9.0.0
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'
23 public:
24  TodoCommentCheck(StringRef Name, ClangTidyContext *Context);
25  void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
26  Preprocessor *ModuleExpanderPP) 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
Base class for all clang-tidy checks.
static constexpr llvm::StringLiteral Name
Finds TODO comments without a username or bug number.
TodoCommentCheck(StringRef Name, ClangTidyContext *Context)
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
Override this to register PPCallbacks in the preprocessor.
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.