forked from OSchip/llvm-project
[clang-tidy] add forwarders in the aliased checks from hicpp module
Summary: Adds redirections notes and the actual redirections in the documentation for hicpp Patch by: Jonas Toth Reviewers: aaron.ballman, hokein, alexfh Reviewed By: aaron.ballman, hokein Subscribers: JDevlieghere, xazax.hun Differential Revision: https://reviews.llvm.org/D36355 llvm-svn: 310577
This commit is contained in:
parent
cf007a7614
commit
75de614684
|
@ -1,9 +1,11 @@
|
|||
.. title:: clang-tidy - hicpp-explicit-conversions
|
||||
.. meta::
|
||||
:http-equiv=refresh: 5;URL=google-explicit-constructor.html
|
||||
|
||||
hicpp-explicit-conversions
|
||||
==========================
|
||||
|
||||
This check is an alias for `google-explicit-constructor <google-explicit-constructor.hml>`_.
|
||||
This check is an alias for `google-explicit-constructor <google-explicit-constructor.html>`_.
|
||||
Used to enforce parts of `rule 5.4.1 <http://www.codingstandard.com/rule/5-4-1-only-use-casting-forms-static_cast-excl-void-dynamic_cast-or-explicit-constructor-call/>`_.
|
||||
This check will enforce that constructors and conversion operators are marked `explicit`.
|
||||
Other forms of casting checks are implemented in other places.
|
||||
|
|
|
@ -1,9 +1,11 @@
|
|||
.. title:: clang-tidy - hicpp-function-size
|
||||
.. meta::
|
||||
:http-equiv=refresh: 5;URL=readability-function-size.html
|
||||
|
||||
hicpp-function-size
|
||||
===================
|
||||
|
||||
This check is an alias for `readability-function-size <readability-function-size.hml>`_.
|
||||
This check is an alias for `readability-function-size <readability-function-size.html>`_.
|
||||
Useful to enforce multiple sections on function complexity.
|
||||
|
||||
- `rule 8.2.2 <http://www.codingstandard.com/rule/8-2-2-do-not-declare-functions-with-an-excessive-number-of-parameters/>`_
|
||||
|
|
|
@ -1,8 +1,10 @@
|
|||
.. title:: clang-tidy - hicpp-invalid-access-moved
|
||||
.. meta::
|
||||
:http-equiv=refresh: 5;URL=misc-use-after-move.html
|
||||
|
||||
hicpp-invalid-access-moved
|
||||
==========================
|
||||
|
||||
This check is an alias for `misc-use-after-move <misc-use-after-move.hml>`_.
|
||||
This check is an alias for `misc-use-after-move <misc-use-after-move.html>`_.
|
||||
|
||||
Implements parts of the `rule 8.4.1 <http://www.codingstandard.com/rule/8-4-1-do-not-access-an-invalid-object-or-an-object-with-indeterminate-value/>`_ to check if moved-from objects are accessed.
|
||||
|
|
|
@ -1,9 +1,11 @@
|
|||
.. title:: clang-tidy - hicpp-member-init
|
||||
.. meta::
|
||||
:http-equiv=refresh: 5;URL=cppcoreguidelines-pro-type-member-init.html
|
||||
|
||||
hicpp-member-init
|
||||
=================
|
||||
|
||||
This check is an alias for `cppcoreguidelines-pro-type-member-init <cppcoreguidelines-pro-type-member-init.hml>`_.
|
||||
This check is an alias for `cppcoreguidelines-pro-type-member-init <cppcoreguidelines-pro-type-member-init.html>`_.
|
||||
Implements the check for
|
||||
`rule 12.4.2 <http://www.codingstandard.com/rule/12-4-2-ensure-that-a-constructor-initializes-explicitly-all-base-classes-and-non-static-data-members/>`_
|
||||
to initialize class members in the right order.
|
||||
|
|
|
@ -1,8 +1,10 @@
|
|||
.. title:: clang-tidy - hicpp-named-parameter
|
||||
.. meta::
|
||||
:http-equiv=refresh: 5;URL=readability-named-parameter.html
|
||||
|
||||
hicpp-named-parameter
|
||||
=====================
|
||||
|
||||
This check is an alias for `readability-named-parameter <readability-named-parameter.hml>`_.
|
||||
This check is an alias for `readability-named-parameter <readability-named-parameter.html>`_.
|
||||
|
||||
Implements `rule 8.2.1 <http://www.codingstandard.com/rule/8-2-1-make-parameter-names-absent-or-identical-in-all-declarations/>`_.
|
||||
|
|
|
@ -1,8 +1,10 @@
|
|||
.. title:: clang-tidy - hicpp-new-delete-operators
|
||||
.. meta::
|
||||
:http-equiv=refresh: 5;URL=misc-new-delete-overloads.html
|
||||
|
||||
hicpp-new-delete-operators
|
||||
==========================
|
||||
|
||||
This check is an alias for `misc-new-delete-overloads <misc-new-delete-overloads.hml>`_.
|
||||
This check is an alias for `misc-new-delete-overloads <misc-new-delete-overloads.html>`_.
|
||||
Implements `rule 12.3.1 <http://www.codingstandard.com/section/12-3-free-store/>`_ to ensure
|
||||
the `new` and `delete` operators have the correct signature.
|
||||
|
|
|
@ -1,7 +1,9 @@
|
|||
.. title:: clang-tidy - hicpp-noexcept-move
|
||||
.. meta::
|
||||
:http-equiv=refresh: 5;URL=misc-noexcept-moveconstructor.html
|
||||
|
||||
hicpp-noexcept-move
|
||||
===================
|
||||
|
||||
This check is an alias for `misc-noexcept-moveconstructor <misc-noexcept-moveconstructor.hml>`_.
|
||||
This check is an alias for `misc-noexcept-moveconstructor <misc-noexcept-moveconstructor.html>`_.
|
||||
Checks `rule 12.5.4 <http://www.codingstandard.com/rule/12-5-4-declare-noexcept-the-move-constructor-and-move-assignment-operator>`_ to mark move assignment and move construction `noexcept`.
|
||||
|
|
|
@ -1,7 +1,9 @@
|
|||
.. title:: clang-tidy - hicpp-special-member-functions
|
||||
.. meta::
|
||||
:http-equiv=refresh: 5;URL=cppcoreguidelines-special-member-functions.html
|
||||
|
||||
hicpp-special-member-functions
|
||||
==============================
|
||||
|
||||
This check is an alias for `cppcoreguidelines-special-member-functions <cppcoreguidelines-special-member-functions.hml>`_.
|
||||
This check is an alias for `cppcoreguidelines-special-member-functions <cppcoreguidelines-special-member-functions.html>`_.
|
||||
Checks that special member functions have the correct signature, according to `rule 12.5.7 <http://www.codingstandard.com/rule/12-5-7-declare-assignment-operators-with-the-ref-qualifier/>`_.
|
||||
|
|
|
@ -1,9 +1,11 @@
|
|||
.. title:: clang-tidy - hicpp-undelegated-construtor
|
||||
.. meta::
|
||||
:http-equiv=refresh: 5;URL=misc-undelegated-constructor.html
|
||||
|
||||
hicpp-undelegated-constructor
|
||||
=============================
|
||||
|
||||
This check is an alias for `misc-undelegated-constructor <misc-undelegated-constructor.hml>`_.
|
||||
This check is an alias for `misc-undelegated-constructor <misc-undelegated-constructor.html>`_.
|
||||
Partially implements `rule 12.4.5 <http://www.codingstandard.com/rule/12-4-5-use-delegating-constructors-to-reduce-code-duplication/>`_
|
||||
to find misplaced constructor calls inside a constructor.
|
||||
|
||||
|
|
|
@ -1,7 +1,9 @@
|
|||
.. title:: clang-tidy - hicpp-use-equals-defaults
|
||||
.. meta::
|
||||
:http-equiv=refresh: 5;URL=modernize-use-equals-default.html
|
||||
|
||||
hicpp-use-equals-default
|
||||
========================
|
||||
|
||||
This check is an alias for `modernize-use-equals-default <modernize-use-equals-default.hml>`_.
|
||||
This check is an alias for `modernize-use-equals-default <modernize-use-equals-default.html>`_.
|
||||
Implements `rule 12.5.1 <http://www.codingstandard.com/rule/12-5-1-define-explicitly-default-or-delete-implicit-special-member-functions-of-concrete-classes/>`_ to explicitly default special member functions.
|
||||
|
|
|
@ -1,8 +1,10 @@
|
|||
.. title:: clang-tidy - hicpp-use-equals-delete
|
||||
.. meta::
|
||||
:http-equiv=refresh: 5;URL=modernize-use-equals-delete.html
|
||||
|
||||
hicpp-use-equals-delete
|
||||
=======================
|
||||
|
||||
This check is an alias for `modernize-use-equals-delete <modernize-use-equals-delete.hml>`_.
|
||||
This check is an alias for `modernize-use-equals-delete <modernize-use-equals-delete.html>`_.
|
||||
Implements `rule 12.5.1 <http://www.codingstandard.com/rule/12-5-1-define-explicitly-default-or-delete-implicit-special-member-functions-of-concrete-classes/>`_
|
||||
to explicitly default or delete special member functions.
|
||||
|
|
|
@ -1,8 +1,10 @@
|
|||
.. title:: clang-tidy - hicpp-use-override
|
||||
.. meta::
|
||||
:http-equiv=refresh: 5;URL=modernize-use-override.html
|
||||
|
||||
hicpp-use-override
|
||||
==================
|
||||
|
||||
This check is an alias for `modernize-use-override <modernize-use-override.hml>`_.
|
||||
This check is an alias for `modernize-use-override <modernize-use-override.html>`_.
|
||||
Implements `rule 10.2.1 <http://www.codingstandard.com/section/10-2-virtual-functions/>`_ to
|
||||
declare a virtual function `override` when overriding.
|
||||
|
|
|
@ -60,19 +60,19 @@ Clang-Tidy Checks
|
|||
google-runtime-member-string-references
|
||||
google-runtime-operator
|
||||
google-runtime-references
|
||||
hicpp-explicit-conversions
|
||||
hicpp-function-size
|
||||
hicpp-invalid-access-moved
|
||||
hicpp-member-init
|
||||
hicpp-named-parameter
|
||||
hicpp-new-delete-operators
|
||||
hicpp-explicit-conversions (redirects to google-explicit-constructor) <hicpp-explicit-conversions>
|
||||
hicpp-function-size (redirects to readability-function-size) <hicpp-function-size>
|
||||
hicpp-invalid-access-moved (redirects to misc-use-after-move) <hicpp-invalid-access-moved>
|
||||
hicpp-member-init (redirects to cppcoreguidelines-pro-type-member-init) <hicpp-member-init>
|
||||
hicpp-named-parameter (redirects to readability-named-parameter) <hicpp-named-parameter>
|
||||
hicpp-new-delete-operators (redirects to misc-new-delete-overloads) <hicpp-new-delete-operators>
|
||||
hicpp-no-assembler
|
||||
hicpp-noexcept-move
|
||||
hicpp-special-member-functions
|
||||
hicpp-undelegated-constructor
|
||||
hicpp-use-equals-default
|
||||
hicpp-use-equals-delete
|
||||
hicpp-use-override
|
||||
hicpp-noexcept-move (redirects to misc-noexcept-moveconstructor) <hicpp-noexcept-move>
|
||||
hicpp-special-member-functions (redirects to cppcoreguidelines-special-member-functions) <hicpp-special-member-functions>
|
||||
hicpp-undelegated-constructor (redirects to misc-undelegated-constructor) <hicpp-undelegated-constructor>
|
||||
hicpp-use-equals-default (redirects to modernize-use-equals-default) <hicpp-use-equals-default>
|
||||
hicpp-use-equals-delete (redirects to modernize-use-equals-delete) <hicpp-use-equals-delete>
|
||||
hicpp-use-override (redirects to modernize-use-override) <hicpp-use-override>
|
||||
llvm-header-guard
|
||||
llvm-include-order
|
||||
llvm-namespace-comment
|
||||
|
|
Loading…
Reference in New Issue