forked from OSchip/llvm-project
[clang-tidy] Add links to check docs in comments
This commit is contained in:
parent
d2ed2f16b8
commit
37558fd29e
|
@ -25,6 +25,9 @@ namespace readability {
|
|||
/// This check is similar to `-Wold-style-cast`, but it suggests automated fixes
|
||||
/// in some cases. The reported locations should not be different from the
|
||||
/// ones generated by `-Wold-style-cast`.
|
||||
///
|
||||
/// For the user-facing documentation see:
|
||||
/// http://clang.llvm.org/extra/clang-tidy/checks/google-readability-casting.html
|
||||
class AvoidCStyleCastsCheck : public ClangTidyCheck {
|
||||
public:
|
||||
AvoidCStyleCastsCheck(StringRef Name, ClangTidyContext *Context)
|
||||
|
|
|
@ -18,6 +18,9 @@ namespace readability {
|
|||
|
||||
// Check for underscores in the names of googletest tests, per
|
||||
// https://github.com/google/googletest/blob/master/googletest/docs/faq.md#why-should-test-suite-names-and-test-names-not-contain-underscore
|
||||
///
|
||||
/// For the user-facing documentation see:
|
||||
/// http://clang.llvm.org/extra/clang-tidy/checks/google-readability-avoid-underscore-in-googletest-name.html
|
||||
class AvoidUnderscoreInGoogletestNameCheck : public ClangTidyCheck {
|
||||
public:
|
||||
using ClangTidyCheck::ClangTidyCheck;
|
||||
|
|
|
@ -18,6 +18,9 @@ namespace google {
|
|||
/// Checks that default parameters are not given for virtual methods.
|
||||
///
|
||||
/// See https://google.github.io/styleguide/cppguide.html#Default_Arguments
|
||||
///
|
||||
/// For the user-facing documentation see:
|
||||
/// http://clang.llvm.org/extra/clang-tidy/checks/google-default-arguments.html
|
||||
class DefaultArgumentsCheck : public ClangTidyCheck {
|
||||
public:
|
||||
DefaultArgumentsCheck(StringRef Name, ClangTidyContext *Context)
|
||||
|
|
|
@ -18,6 +18,9 @@ namespace google {
|
|||
/// Checks that all single-argument constructors are explicit.
|
||||
///
|
||||
/// See https://google.github.io/styleguide/cppguide.html#Explicit_Constructors
|
||||
///
|
||||
/// For the user-facing documentation see:
|
||||
/// http://clang.llvm.org/extra/clang-tidy/checks/google-explicit-constructor.html
|
||||
class ExplicitConstructorCheck : public ClangTidyCheck {
|
||||
public:
|
||||
ExplicitConstructorCheck(StringRef Name, ClangTidyContext *Context)
|
||||
|
|
|
@ -22,6 +22,9 @@ namespace build {
|
|||
/// specified explicitly, and such use isn't intended in any case.
|
||||
///
|
||||
/// Corresponding cpplint.py check name: 'build/explicit_make_pair'.
|
||||
///
|
||||
/// For the user-facing documentation see:
|
||||
/// http://clang.llvm.org/extra/clang-tidy/checks/google-build-explicit-make-pair.html
|
||||
class ExplicitMakePairCheck : public ClangTidyCheck {
|
||||
public:
|
||||
ExplicitMakePairCheck(StringRef Name, ClangTidyContext *Context)
|
||||
|
|
|
@ -27,6 +27,9 @@ namespace readability {
|
|||
///
|
||||
/// For extension-less header files, using an empty string or leaving an
|
||||
/// empty string between ";" if there are other filename extensions.
|
||||
///
|
||||
/// For the user-facing documentation see:
|
||||
/// http://clang.llvm.org/extra/clang-tidy/checks/google-global-names-in-headers.html
|
||||
class GlobalNamesInHeadersCheck : public ClangTidyCheck {
|
||||
public:
|
||||
GlobalNamesInHeadersCheck(StringRef Name, ClangTidyContext *Context);
|
||||
|
|
|
@ -25,6 +25,9 @@ namespace runtime {
|
|||
/// with `u?intXX(_t)?`.
|
||||
///
|
||||
/// Corresponding cpplint.py check: 'runtime/int'.
|
||||
///
|
||||
/// For the user-facing documentation see:
|
||||
/// http://clang.llvm.org/extra/clang-tidy/checks/google-runtime-int.html
|
||||
class IntegerTypesCheck : public ClangTidyCheck {
|
||||
public:
|
||||
IntegerTypesCheck(StringRef Name, ClangTidyContext *Context);
|
||||
|
|
|
@ -21,6 +21,9 @@ namespace runtime {
|
|||
/// https://google.github.io/styleguide/cppguide.html#Operator_Overloading
|
||||
///
|
||||
/// Corresponding cpplint.py check name: 'runtime/operator'.
|
||||
///
|
||||
/// For the user-facing documentation see:
|
||||
/// http://clang.llvm.org/extra/clang-tidy/checks/google-runtime-operator.html
|
||||
class OverloadedUnaryAndCheck : public ClangTidyCheck {
|
||||
public:
|
||||
OverloadedUnaryAndCheck(StringRef Name, ClangTidyContext *Context)
|
||||
|
|
|
@ -19,6 +19,9 @@ namespace readability {
|
|||
/// Finds TODO comments without a username or bug number.
|
||||
///
|
||||
/// Corresponding cpplint.py check: 'readability/todo'
|
||||
///
|
||||
/// For the user-facing documentation see:
|
||||
/// http://clang.llvm.org/extra/clang-tidy/checks/google-readability-todo.html
|
||||
class TodoCommentCheck : public ClangTidyCheck {
|
||||
public:
|
||||
TodoCommentCheck(StringRef Name, ClangTidyContext *Context);
|
||||
|
|
|
@ -30,6 +30,9 @@ namespace build {
|
|||
/// https://google.github.io/styleguide/cppguide.html#Namespaces
|
||||
///
|
||||
/// Corresponding cpplint.py check name: 'build/namespaces'.
|
||||
///
|
||||
/// For the user-facing documentation see:
|
||||
/// http://clang.llvm.org/extra/clang-tidy/checks/google-build-namespaces.html
|
||||
class UnnamedNamespaceInHeaderCheck : public ClangTidyCheck {
|
||||
public:
|
||||
UnnamedNamespaceInHeaderCheck(StringRef Name, ClangTidyContext *Context);
|
||||
|
|
|
@ -31,6 +31,9 @@ namespace build {
|
|||
/// \endcode
|
||||
///
|
||||
/// Corresponding cpplint.py check name: `build/namespaces`.
|
||||
///
|
||||
/// For the user-facing documentation see:
|
||||
/// https://clang.llvm.org/extra/clang-tidy/checks/google-build-using-namespace.html
|
||||
class UsingNamespaceDirectiveCheck : public ClangTidyCheck {
|
||||
public:
|
||||
UsingNamespaceDirectiveCheck(StringRef Name, ClangTidyContext *Context)
|
||||
|
|
Loading…
Reference in New Issue