clang-tools-extra/clang-tidy/readability/NamedParameterCheck.h

   1 //===--- NamedParameterCheck.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_READABILITY_NAMEDPARAMETERCHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_NAMEDPARAMETERCHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang::tidy::readability {
  15
  16 /// Find functions with unnamed arguments.
  17 ///
  18 /// The check implements the following rule originating in the Google C++ Style
  19 /// Guide:
  20 ///
  21 /// https://google.github.io/styleguide/cppguide.html#Function_Declarations_and_Definitions
  22 ///
  23 /// All parameters should be named, with identical names in the declaration and
  24 /// implementation.
  25 ///
  26 /// Corresponding cpplint.py check name: 'readability/function'.
  27 class NamedParameterCheck : public ClangTidyCheck {
  28 public:
  29   NamedParameterCheck(StringRef Name, ClangTidyContext *Context)
  30       : ClangTidyCheck(Name, Context) {}
  31   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  32   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  33   std::optional<TraversalKind> getCheckTraversalKind() const override {
  34     return TK_IgnoreUnlessSpelledInSource;
  35   }
  36 };
  37
  38 } // namespace clang::tidy::readability
  39
  40 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_NAMEDPARAMETERCHECK_H