clang-tools  6.0.0svn
Public Member Functions | List of all members
clang::tidy::readability::NamespaceCommentCheck Class Reference

Checks that long namespaces have a closing comment. More...

#include <NamespaceCommentCheck.h>

Inheritance diagram for clang::tidy::readability::NamespaceCommentCheck:
Inheritance graph
[legend]
Collaboration diagram for clang::tidy::readability::NamespaceCommentCheck:
Collaboration graph
[legend]

Public Member Functions

 NamespaceCommentCheck (StringRef Name, ClangTidyContext *Context)
 
void registerMatchers (ast_matchers::MatchFinder *Finder) override
 Override this to register AST matchers with Finder. More...
 
void check (const ast_matchers::MatchFinder::MatchResult &Result) override
 ClangTidyChecks that register ASTMatchers should do the actual work in here. More...
 
- Public Member Functions inherited from clang::tidy::ClangTidyCheck
 ClangTidyCheck (StringRef CheckName, ClangTidyContext *Context)
 Initializes the check with CheckName and Context. More...
 
virtual void registerPPCallbacks (CompilerInstance &Compiler)
 Override this to register PPCallbacks with Compiler. More...
 
DiagnosticBuilder diag (SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
 Add a diagnostic with the check's name. More...
 

Additional Inherited Members

- Protected Member Functions inherited from clang::tidy::ClangTidyCheck
StringRef getCurrentMainFile () const
 Returns the main file name of the current translation unit. More...
 
LangOptions getLangOpts () const
 Returns the language options from the context. More...
 
- Protected Attributes inherited from clang::tidy::ClangTidyCheck
OptionsView Options
 

Detailed Description

Checks that long namespaces have a closing comment.

http://llvm.org/docs/CodingStandards.html#namespace-indentation

https://google.github.io/styleguide/cppguide.html#Namespaces

Definition at line 25 of file NamespaceCommentCheck.h.

Constructor & Destructor Documentation

◆ NamespaceCommentCheck()

clang::tidy::readability::NamespaceCommentCheck::NamespaceCommentCheck ( StringRef  Name,
ClangTidyContext Context 
)

Definition at line 22 of file NamespaceCommentCheck.cpp.

Member Function Documentation

◆ check()

void clang::tidy::readability::NamespaceCommentCheck::check ( const ast_matchers::MatchFinder::MatchResult &  Result)
overridevirtual

◆ registerMatchers()

void clang::tidy::readability::NamespaceCommentCheck::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.

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 36 of file NamespaceCommentCheck.cpp.


The documentation for this class was generated from the following files: