Skip to content

Commit

Permalink
docs: updated the project's documentation
Browse files Browse the repository at this point in the history
FossilOrigin-Name: b90ef385cf69b11d99982746f26a24ce9409aff788759c616aa68211699ad025
  • Loading branch information
thindil committed Jun 11, 2024
1 parent 1753d51 commit 955f74e
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions doc/available_rules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -882,6 +882,7 @@ Params rule
The rule to check the parameters of routines. Checked things:

* Do the routine uses all its parameters.
* Do the routine uses string or int for its parameters.

The syntax in a configuration file is::

Expand All @@ -903,6 +904,10 @@ The syntax in a configuration file is::
Probably useable only with search and count type of rule.
* params is the name of the rule. It is case-insensitive, thus it can be
set as *Params*, *params* or *pArAmS*.
* checkType is the type of check to perform by the rule. Possible values:
`used`: check do all parameters of routines are used. `standardtypes`:
check do routines use string or int for their parameters. `all`: perform
all the rule's checks.
* declarationType is the type of declaration which will be checked for the
parameters usage. Possible values: `procedures`: check all procedures,
functions and methods. `templates`: check templates only. `macros`: check
Expand Down Expand Up @@ -930,11 +935,11 @@ Examples

1. Check if all procedures in module uses their parameters::

check params procedures
check params used procedures

2. Search for all declarations which don't use their all parameters::

search not params all
search not params used all

Trystatements rule
==================
Expand Down

0 comments on commit 955f74e

Please sign in to comment.