clang-tools 17.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
15
16/// Finds TODO comments without a username or bug number.
17///
18/// Corresponding cpplint.py check: 'readability/todo'
19///
20/// For the user-facing documentation see:
21/// http://clang.llvm.org/extra/clang-tidy/checks/google/readability-todo.html
23public:
24 TodoCommentCheck(StringRef Name, ClangTidyContext *Context);
26
27 void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
28 Preprocessor *ModuleExpanderPP) override;
29
30private:
32 std::unique_ptr<TodoCommentHandler> Handler;
33};
34
35} // namespace clang::tidy::google::readability
36
37#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_TODOCOMMENTCHECK_H
Token Name
Base class for all clang-tidy checks.
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Finds TODO comments without a username or bug number.
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
Override this to register PPCallbacks in the preprocessor.