Skip to content

Commit

Permalink
docs: updated the project's documentation
Browse files Browse the repository at this point in the history
FossilOrigin-Name: f2a0e51e9f2f0508395aa6bb11a26014a18547f96de8d7bfb81f748ea5941525
  • Loading branch information
thindil committed Apr 12, 2024
1 parent f284012 commit 1013fd7
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions doc/available_rules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------------
Expand All @@ -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::

Expand Down

0 comments on commit 1013fd7

Please sign in to comment.