From 1013fd723a9bf2ba29b5324c114a82b5c5280d68 Mon Sep 17 00:00:00 2001 From: thindil Date: Fri, 12 Apr 2024 06:10:44 +0000 Subject: [PATCH] docs: updated the project's documentation FossilOrigin-Name: f2a0e51e9f2f0508395aa6bb11a26014a18547f96de8d7bfb81f748ea5941525 --- doc/available_rules.rst | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/doc/available_rules.rst b/doc/available_rules.rst index 3c2a766..5e759ca 100644 --- a/doc/available_rules.rst +++ b/doc/available_rules.rst @@ -824,15 +824,19 @@ The syntax in a configuration file is:: Search type will list all declarations which violates the check or raise an error if nothing found. Count type will simply list the amount of the declarations which violates the check. Fix type will add or remove public mark - `*` from fields' of the object's type's declaration. + `*` from fields' of the object's type's declaration but only when **checkType** + is set to *publicfields*. * optional word *not* means negation for the rule. Adding word *not* will change to inform only about objects' types' declarations which have only private fields. * objects is the name of the rule. It is case-insensitive, thus it can be set as *objects*, *objects* or *oBjEcTs*. * checkType is the type of checks to perform on the objects' declarations. Proper - value is: *publicfields*. Setting it to publicfieds will check existence of - objects declarations which not contains public fields. + values are: *publicfields*, *all*, *standardtypes*. Setting it to publicfieds + will check existence of objects declarations which contains public fields. + Setting it to *standardtypes* will check existence of objects' declarations + which contains fields with string or int type. Setting it to all will perform + all checks. Disabling the rule ------------------ @@ -858,9 +862,9 @@ should be:: Examples -------- -1. Check if all objects' types' declarations contains public fields:: +1. Check if all objects' types' declarations contains public fields and standard types:: - check objects publicfields + check objects all 2. Made all object's types' fields private::