Checks that argument comments match parameter names. More...

#include <ArgumentCommentCheck.h>

Inheritance diagram for clang::tidy::bugprone::ArgumentCommentCheck:

Public Member Functions
	ArgumentCommentCheck (StringRef Name, ClangTidyContext *Context)

void	registerMatchers (ast_matchers::MatchFinder *Finder) override
	Override this to register AST matchers with `Finder`.

void	check (const ast_matchers::MatchFinder::MatchResult &Result) override
	`ClangTidyChecks` that register ASTMatchers should do the actual work in here.

void	storeOptions (ClangTidyOptions::OptionMap &Opts) override
	Should store all options supported by this check with their current values or default values for options that haven't been overridden.

Public Member Functions inherited from clang::tidy::ClangTidyCheck
	ClangTidyCheck (StringRef CheckName, ClangTidyContext *Context)
	Initializes the check with `CheckName` and `Context`.

virtual bool	isLanguageVersionSupported (const LangOptions &LangOpts) const
	Override this to disable registering matchers and PP callbacks if an invalid language version is being used.

virtual void	registerPPCallbacks (const SourceManager &SM, Preprocessor PP, Preprocessor ModuleExpanderPP)
	Override this to register `PPCallbacks` in the preprocessor.

virtual void	registerMatchers (ast_matchers::MatchFinder *Finder)
	Override this to register AST matchers with `Finder`.

virtual void	check (const ast_matchers::MatchFinder::MatchResult &Result)
	`ClangTidyChecks` that register ASTMatchers should do the actual work in here.

DiagnosticBuilder	diag (SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
	Add a diagnostic with the check's name.

DiagnosticBuilder	diag (StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
	Add a diagnostic with the check's name.

DiagnosticBuilder	configurationDiag (StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning) const
	Adds a diagnostic to report errors in the check's configuration.

virtual void	storeOptions (ClangTidyOptions::OptionMap &Options)
	Should store all options supported by this check with their current values or default values for options that haven't been overridden.

Additional Inherited Members
Protected Member Functions inherited from clang::tidy::ClangTidyCheck
StringRef	getCurrentMainFile () const
	Returns the main file name of the current translation unit.

const LangOptions &	getLangOpts () const
	Returns the language options from the context.

bool	areDiagsSelfContained () const
	Returns true when the check is run in a use case when only 1 fix will be applied at a time.

StringRef	getID () const override

Protected Attributes inherited from clang::tidy::ClangTidyCheck
OptionsView	Options

Detailed Description

Checks that argument comments match parameter names.

The check understands argument comments in the form /*parameter_name=*&zwj;/ that are placed right before the argument.

void f(bool foo);
 
...
f(/*bar=*/true);
// warning: argument name 'bar' in comment does not match parameter name
'foo'

The check tries to detect typos and suggest automated fixes for them.

Definition at line 32 of file ArgumentCommentCheck.h.

Constructor & Destructor Documentation

◆ ArgumentCommentCheck()

clang::tidy::bugprone::ArgumentCommentCheck::ArgumentCommentCheck	(	StringRef	Name,
		ClangTidyContext *	Context
	)

Definition at line 32 of file ArgumentCommentCheck.cpp.

Member Function Documentation

◆ check()

void clang::tidy::bugprone::ArgumentCommentCheck::check ( const ast_matchers::MatchFinder::MatchResult & Result )

overridevirtual

ClangTidyChecks that register ASTMatchers should do the actual work in here.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 346 of file ArgumentCommentCheck.cpp.

References E.

◆ registerMatchers()

void clang::tidy::bugprone::ArgumentCommentCheck::registerMatchers ( ast_matchers::MatchFinder * Finder )

overridevirtual

Override this to register AST matchers with Finder.

This should be used by clang-tidy checks that analyze code properties that dependent on AST knowledge.

You can register as many matchers as necessary with Finder. Usually, "this" will be used as callback, but you can also specify other callback classes. Thereby, different matchers can trigger different callbacks.

This will only be executed if the function isLanguageVersionSupported returns true.

If you need to merge information between the different matchers, you can store these as members of the derived class. However, note that all matches occur in the order of the AST traversal.

Reimplemented from clang::tidy::ClangTidyCheck.

Definition at line 59 of file ArgumentCommentCheck.cpp.