Adding inline documentation

cybersonic · Feb 12, 2025 · c5f850e · c5f850e
1 parent bf9decf
commit c5f850e
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/server/src/main/cfml/cfrules/CFRules.cfc b/server/src/main/cfml/cfrules/CFRules.cfc
@@ -54,6 +54,11 @@ component accessors="true" {
         return ret;
     }
 
+    /**
+     * extension_not_allowed checks for file extensions defined in the `value` key of the rule an makes sure that it is not present in the directory defied in the `path` key
+     *
+     * @rule 
+     */
     array function extension_not_allowed(struct rule) {
         var foundItems = [];
         var path = getRootPath() & (rule.path ?: '');
@@ -99,7 +104,11 @@ component accessors="true" {
         return foundItems;
     }
 
-    array function folder_not_allowed(struct rule) {
+    /**
+     * folder_not_allowed checks for folders defined in the `value` key of the rule an makes sure that it is not present in the directory defied in the `path` key
+     *
+     * @rule 
+     */array function folder_not_allowed(struct rule) {
         var foundItems = [];
         var path = getRootPath() & (rule.path ?: '');
         if (!directoryExists(path)) {