diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-identifier-naming.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-identifier-naming.rst --- a/clang-tools-extra/docs/clang-tidy/checks/readability-identifier-naming.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/readability-identifier-naming.rst @@ -2742,3 +2742,459 @@ double dValueDouble = 0.0; ULONG ulValueUlong = 0; DWORD dwValueDword = 0; + +Resolution order +------- + +The full set of identifier classifications listed above includes some overlap, +where an individual identifier can falling into several classifications. Bellow +is a list of the classifications supported by ``readability-identifier-naming`` +presented in the order in which the classifications are resolved. Some +classifications appear multiple times as they can be checked in different +contexts. The check returns as soon as the first valid classification is +matched. This occurs when the semantics of the identifier match and there is a +valid option for the classification present in the ``.clang-tidy`` file - e.g., +``readability-identifier-naming.AbstractClassCase``. + + - Typedef ``[typedef]`` + - TypeAlias ``[using Alias = ...]`` + - InlineNamespace ``[inline namespace]`` + - Namespace ```[namespace]`` + - + - ScopedEnumValue ``[enum class member]`` + - EnumConstant ``[enum member]`` + - Constant + - Invalid + - + - AbstractClass ``[class, struct, pure-virtual present]`` + - Struct ``[struct]`` + - Class ``[class, struct]`` + - Struct ``[class]`` + - Union ``[union]`` + - Enum ``[enum, enum class]`` + - Invalid + - - does not cover ``[static, constexpr]`` + - ``[const]`` + - ConstantMember + - Constant + - PrivateMember ``[private]`` + - ProtectedMember ``[protected]`` + - PublicMember ``[public]`` + - Member + - Invalid + - + - ConstexprVariable ``[constexpr]`` + - ``[const]`` + - ConstantPointerParameter ``[*]`` + - ConstantParameter + - Constant + - ParameterPack ``[...]`` + - PointerParameter ``[*]`` + - Parameter + - Invalid + - + - ConstexprVariable ``[constexpr]`` + - ``[const]`` + - ClassConstant ``[const, static]`` + - + - GlobalConstantPointer ``[const *]`` + - GlobalConstant ``[const]`` + - StaticConstant ``[static, const]`` + - + - LocalConstantPointer ``[const *]`` + - LocalConstant ``[const]`` + - Constant ``[const]`` + - + - ClassMember ``[static]`` + - + - GlobalPointer ``[*]`` + - GlobalVariable + - + - StaticVariable ``[static]`` + - LocalPointer ``[*]`` + - LocalVariable + - + - LocalVariable + - Variable + - + - + - ``[constexpr]`` + - ConstexprMethod + - ConstexprFunction + - ClassMethod ``[static]`` + - VirtualMethod ``[virtual]`` + - PrivateMethod ``[private]`` + - ProtectedMethod ``[protected]`` + - PublicMethod ``[public]`` + - Method + - Function + - Invalid + - + - + - ConstexprFunction ``[constexpr]`` + - GlobalFunction ``[static method, static function, in any namespace]`` + - Function + - Invalid + -