clang-tools  14.0.0git
NamedParameterCheck.h
Go to the documentation of this file.
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 {
15 namespace tidy {
16 namespace readability {
17 
18 /// Find functions with unnamed arguments.
19 ///
20 /// The check implements the following rule originating in the Google C++ Style
21 /// Guide:
22 ///
23 /// https://google.github.io/styleguide/cppguide.html#Function_Declarations_and_Definitions
24 ///
25 /// All parameters should be named, with identical names in the declaration and
26 /// implementation.
27 ///
28 /// Corresponding cpplint.py check name: 'readability/function'.
30 public:
32  : ClangTidyCheck(Name, Context) {}
33  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
34  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
35  llvm::Optional<TraversalKind> getCheckTraversalKind() const override {
36  return TK_IgnoreUnlessSpelledInSource;
37  }
38 };
39 
40 } // namespace readability
41 } // namespace tidy
42 } // namespace clang
43 
44 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_NAMEDPARAMETERCHECK_H
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::readability::NamedParameterCheck::getCheckTraversalKind
llvm::Optional< TraversalKind > getCheckTraversalKind() const override
Definition: NamedParameterCheck.h:35
clang::tidy::readability::NamedParameterCheck::NamedParameterCheck
NamedParameterCheck(StringRef Name, ClangTidyContext *Context)
Definition: NamedParameterCheck.h:31
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:72
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::readability::NamedParameterCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: NamedParameterCheck.cpp:24
clang::tidy::readability::NamedParameterCheck
Find functions with unnamed arguments.
Definition: NamedParameterCheck.h:29
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::readability::NamedParameterCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: NamedParameterCheck.cpp:20