================
@@ -223,6 +226,60 @@ Options description
 
 A detailed description of each option is presented below:
 
+.. option:: DefaultCase
+
+    When defined, the check will ensure all name by default conform to the
+    selected casing.
+
+.. option:: DefaultPrefix
+
+    When defined, the check will ensure all name by default will add the
+    prefixed with the given value (regardless of casing).
+
+.. option:: DefaultIgnoredRegexp
+
+    Identifier naming checks won't be enforced for all name by default
+    matching this regular expression.
+
+.. option:: DefaultSuffix
+
+    When defined, the check will ensure all name by default will add the
+    suffix with the given value (regardless of casing).
+
+.. option:: DefaultHungarianPrefix
+
+    When enabled, the check ensures that the declared identifier will
+    have a Hungarian notation prefix based on the declared type.
+
+The check only works on kinds of identifiers which have been configured,
+so an empty config effectively disables it.
+The "default" option can be used to enable all kinds of identifiers,
+then optionally override specific kinds which are desired with a different 
case.
+
+For example using values of:
+
+    - DefaultCase of ``lower_case``
+    - MacroDefinitionCase of ``UPPER_CASE``
+    - TemplateParameterCase of ``CamelCase``
+
+Identifies and/or transforms names as follows:
+
+Before:
+
+.. code-block:: c++
+
+    #define macroDefinition
+    template <typename typenameParameter>
+    int functionDeclaration(typenameParameter paramVal, int paramCount);
+
+After:
+
+.. code-block:: c++
+
+    #define MACRO_DEFINITION
+    template <typename TypenameParameter>
+    int function_declarations(TypenameParameter param_val, int param_count);
+
----------------
vbvictor wrote:

Please place this part in main description of the check, not "options" 
description 

https://github.com/llvm/llvm-project/pull/171686
_______________________________________________
cfe-commits mailing list
[email protected]
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

Reply via email to