docs: added code documentation in ifstatements rule

FossilOrigin-Name: eaf9ea2dcef647b099bfd946f49790fc4e02bbf03f307be7d090d879a936246f
thindil · Mar 17, 2024 · a7aa4f2 · a7aa4f2
1 parent 8097aa3
commit a7aa4f2
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/src/rules/ifstatements.nim b/src/rules/ifstatements.nim
@@ -129,6 +129,12 @@ ruleConfig(ruleName = "ifstatements",
 {.push ruleOff: "paramsUsed".}
 proc checkMinMax(node, parent: PNode; messagePrefix: string;
     rule: var RuleOptions) {.raises: [ValueError], tags: [RootEffect], contractual.} =
+  ## Check the amount of branches of the selected if statement
+  ##
+  ## * node          - the node which will be checked
+  ## * parent        - the parent node of the node to check
+  ## * messagePrefix - the prefix added to the log message, set by the program
+  ## * rule          - the rule options set by the user
   body:
     let astNode: PNode = parent
     var checkResult: bool = true
@@ -150,6 +156,12 @@ proc checkMinMax(node, parent: PNode; messagePrefix: string;
 
 proc checkEmptyBranch(node, parent: PNode; messagePrefix: string;
     rule: var RuleOptions; checkResult: var bool) {.raises: [], tags: [RootEffect], contractual.} =
+  ## Check the if statement for empty branches
+  ##
+  ## * node          - the node which will be checked
+  ## * parent        - the parent node of the node to check
+  ## * messagePrefix - the prefix added to the log message, set by the program
+  ## * rule          - the rule options set by the user
   body:
     let astNode: PNode = parent
     for child in node: