Skip to content

Commit

Permalink
docs: updated code documentation for objects rules
Browse files Browse the repository at this point in the history
FossilOrigin-Name: 5d75af86ddfa34911c4eb5e6e2e2d711bc241802d2a6a29a33c8d1dd4dc5afaf
  • Loading branch information
thindil committed Apr 12, 2024
1 parent e3744f4 commit f284012
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions src/rules/objects.nim
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,11 @@
## * 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
## values are: *publicfields*, *all*. Setting it to publicfieds will check existence of
## objects declarations which not contains public fields. Setting it to all will
## perform all checks.
## 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 @@ -75,9 +77,9 @@
## 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 f284012

Please sign in to comment.