clang-tools
3.9.0
Main Page
Namespaces
Classes
Files
File List
File Members
llvm.src
tools
clang
tools
extra
clang-tidy
misc
ArgumentCommentCheck.h
Go to the documentation of this file.
1
//===--- ArgumentCommentCheck.h - clang-tidy --------------------*- C++ -*-===//
2
//
3
// The LLVM Compiler Infrastructure
4
//
5
// This file is distributed under the University of Illinois Open Source
6
// License. See LICENSE.TXT for details.
7
//
8
//===----------------------------------------------------------------------===//
9
10
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_ARGUMENTCOMMENTCHECK_H
11
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_ARGUMENTCOMMENTCHECK_H
12
13
#include "../ClangTidy.h"
14
#include "llvm/Support/Regex.h"
15
16
namespace
clang {
17
namespace
tidy {
18
namespace
misc {
19
20
/// Checks that argument comments match parameter names.
21
///
22
/// The check understands argument comments in the form `/*parameter_name=*/`
23
/// that are placed right before the argument.
24
///
25
/// \code
26
/// void f(bool foo);
27
///
28
/// ...
29
/// f(/*bar=*/true);
30
/// // warning: argument name 'bar' in comment does not match parameter name 'foo'
31
/// \endcode
32
///
33
/// The check tries to detect typos and suggest automated fixes for them.
34
class
ArgumentCommentCheck
:
public
ClangTidyCheck
{
35
public
:
36
ArgumentCommentCheck
(StringRef
Name
,
ClangTidyContext
*
Context
);
37
38
void
registerMatchers
(ast_matchers::MatchFinder *
Finder
)
override
;
39
void
check
(
const
ast_matchers::MatchFinder::MatchResult &
Result
)
override
;
40
41
private
:
42
llvm::Regex IdentRE;
43
44
bool
isLikelyTypo(llvm::ArrayRef<ParmVarDecl *> Params, StringRef ArgName,
45
unsigned
ArgIndex);
46
void
checkCallArgs(ASTContext *Ctx,
const
FunctionDecl *Callee,
47
SourceLocation ArgBeginLoc,
48
llvm::ArrayRef<const Expr *> Args);
49
};
50
51
}
// namespace misc
52
}
// namespace tidy
53
}
// namespace clang
54
55
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_ARGUMENTCOMMENTCHECK_H
Name
const std::string Name
Definition:
USRFinder.cpp:140
clang::tidy::misc::ArgumentCommentCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition:
ArgumentCommentCheck.cpp:27
Finder
std::unique_ptr< ast_matchers::MatchFinder > Finder
Definition:
ClangTidy.cpp:210
clang::tidy::misc::ArgumentCommentCheck
Definition:
ArgumentCommentCheck.h:34
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition:
ClangTidy.h:110
clang::tidy::misc::ArgumentCommentCheck::ArgumentCommentCheck
ArgumentCommentCheck(StringRef Name, ClangTidyContext *Context)
Definition:
ArgumentCommentCheck.cpp:22
clang::tidy::misc::ArgumentCommentCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition:
ArgumentCommentCheck.cpp:164
Context
ClangTidyContext & Context
Definition:
ClangTidy.cpp:93
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition:
ClangTidyDiagnosticConsumer.h:135
Result
const NamedDecl * Result
Definition:
USRFinder.cpp:137
Generated on Wed Aug 31 2016 16:57:10 for clang-tools by
1.8.6