clang-tools
15.0.0git
llvm-project
clang-tools-extra
clang-tidy
readability
NamespaceCommentCheck.h
Go to the documentation of this file.
1
//===--- NamespaceCommentCheck.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_NAMESPACECOMMENTCHECK_H
10
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_NAMESPACECOMMENTCHECK_H
11
12
#include "../ClangTidyCheck.h"
13
#include "llvm/Support/Regex.h"
14
15
namespace
clang
{
16
namespace
tidy {
17
namespace
readability {
18
19
/// Checks that long namespaces have a closing comment.
20
///
21
/// http://llvm.org/docs/CodingStandards.html#namespace-indentation
22
///
23
/// https://google.github.io/styleguide/cppguide.html#Namespaces
24
class
NamespaceCommentCheck
:
public
ClangTidyCheck
{
25
public
:
26
NamespaceCommentCheck
(StringRef
Name
,
ClangTidyContext
*Context);
27
bool
isLanguageVersionSupported
(
const
LangOptions &
LangOpts
)
const override
{
28
return
LangOpts
.CPlusPlus;
29
}
30
void
registerMatchers
(ast_matchers::MatchFinder *Finder)
override
;
31
void
check
(
const
ast_matchers::MatchFinder::MatchResult &Result)
override
;
32
33
private
:
34
void
storeOptions(
ClangTidyOptions::OptionMap
&
Options
)
override
;
35
36
llvm::Regex NamespaceCommentPattern;
37
const
unsigned
ShortNamespaceLines;
38
const
unsigned
SpacesBeforeComments;
39
llvm::SmallVector<SourceLocation, 4> Ends;
40
};
41
42
}
// namespace readability
43
}
// namespace tidy
44
}
// namespace clang
45
46
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_NAMESPACECOMMENTCHECK_H
clang::tidy::readability::NamespaceCommentCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition:
NamespaceCommentCheck.cpp:38
clang::tidy::readability::NamespaceCommentCheck
Checks that long namespaces have a closing comment.
Definition:
NamespaceCommentCheck.h:24
clang::tidy::readability::NamespaceCommentCheck::NamespaceCommentCheck
NamespaceCommentCheck(StringRef Name, ClangTidyContext *Context)
Definition:
NamespaceCommentCheck.cpp:24
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition:
ClangTidyOptions.h:115
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition:
ClangTidyCheck.h:53
clang::tidy::readability::NamespaceCommentCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition:
NamespaceCommentCheck.cpp:83
clang::tidy::ClangTidyCheck::Options
OptionsView Options
Definition:
ClangTidyCheck.h:415
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition:
ClangTidyDiagnosticConsumer.h:67
Name
Token Name
Definition:
MacroToEnumCheck.cpp:89
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition:
ApplyReplacements.h:27
LangOpts
const LangOptions * LangOpts
Definition:
ExtractFunction.cpp:366
clang::tidy::readability::NamespaceCommentCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition:
NamespaceCommentCheck.h:27
Generated on Sat Jun 25 2022 12:41:25 for clang-tools by
1.8.17