clang-tools
9.0.0
llvm.src
tools
clang
tools
extra
clang-tidy
google
FunctionNamingCheck.h
Go to the documentation of this file.
1
//===--- FunctionNamingCheck.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_OBJC_FUNCTION_NAMING_CHECK_H
10
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_OBJC_FUNCTION_NAMING_CHECK_H
11
12
#include "../ClangTidyCheck.h"
13
#include "llvm/ADT/StringRef.h"
14
15
namespace
clang
{
16
namespace
tidy {
17
namespace
google {
18
namespace
objc {
19
20
/// Finds function names that do not conform to the recommendations of the
21
/// Google Objective-C Style Guide. Function names should be in upper camel case
22
/// including capitalized acronyms and initialisms. Functions that are not of
23
/// static storage class must also have an appropriate prefix. The function
24
/// `main` is an exception. Note that this check does not apply to Objective-C
25
/// method or property declarations.
26
///
27
/// For the user-facing documentation see:
28
/// http://clang.llvm.org/extra/clang-tidy/checks/google-objc-function-naming.html
29
class
FunctionNamingCheck
:
public
ClangTidyCheck
{
30
public
:
31
FunctionNamingCheck
(StringRef
Name
,
ClangTidyContext
*Context)
32
:
ClangTidyCheck
(Name, Context) {}
33
void
registerMatchers
(ast_matchers::MatchFinder *Finder)
override
;
34
void
check
(
const
ast_matchers::MatchFinder::MatchResult &
Result
)
override
;
35
};
36
37
}
// namespace objc
38
}
// namespace google
39
}
// namespace tidy
40
}
// namespace clang
41
42
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_OBJC_FUNCTION_NAMING_CHECK_H
clang::tidy::google::objc::FunctionNamingCheck
Finds function names that do not conform to the recommendations of the Google Objective-C Style Guide...
Definition:
FunctionNamingCheck.h:29
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition:
ClangTidyCheck.h:47
clang::tidy::google::objc::FunctionNamingCheck::FunctionNamingCheck
FunctionNamingCheck(StringRef Name, ClangTidyContext *Context)
Definition:
FunctionNamingCheck.h:31
Name
static constexpr llvm::StringLiteral Name
Definition:
UppercaseLiteralSuffixCheck.cpp:27
clang::tidy::google::objc::FunctionNamingCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition:
FunctionNamingCheck.cpp:113
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition:
ApplyReplacements.h:27
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition:
ClangTidyDiagnosticConsumer.h:99
Result
llvm::Optional< llvm::Expected< tooling::AtomicChanges > > Result
Definition:
Rename.cpp:36
clang::tidy::google::objc::FunctionNamingCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition:
FunctionNamingCheck.cpp:91
Generated on Fri Sep 13 2019 12:53:26 for clang-tools by
1.8.13