clang-tools-extra/clang-tidy/google/TodoCommentCheck.h

   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::tidy::google::readability {
  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
  22 class TodoCommentCheck : public ClangTidyCheck {
  23 public:
  24   TodoCommentCheck(StringRef Name, ClangTidyContext *Context);
  25   ~TodoCommentCheck();
  26
  27   void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
  28                            Preprocessor *ModuleExpanderPP) override;
  29
  30 private:
  31   class TodoCommentHandler;
  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