Add doc-blocks (#410)

To improve understanding of mayDependOnComponents and shouldOnlyDependOnComponents
phparkitect · May 8, 2024 · 21bf268 · 21bf268
1 parent 4530d3d
commit 21bf268
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/src/RuleBuilders/Architecture/MayDependOnComponents.php b/src/RuleBuilders/Architecture/MayDependOnComponents.php
@@ -5,6 +5,12 @@
 
 interface MayDependOnComponents
 {
-    /** @return Where&Rules */
+    /**
+     * May depend on the specified components, plus itself.
+     *
+     * @param string[] $componentNames
+     *
+     * @return Where&Rules
+     */
     public function mayDependOnComponents(string ...$componentNames);
 }
diff --git a/src/RuleBuilders/Architecture/ShouldOnlyDependOnComponents.php b/src/RuleBuilders/Architecture/ShouldOnlyDependOnComponents.php
@@ -5,6 +5,12 @@
 
 interface ShouldOnlyDependOnComponents
 {
-    /** @return Where&Rules */
+    /**
+     * May depend ONLY on the specified components, thus it can only depend on itself if itself is specified.
+     *
+     * @param string[] $componentNames
+     *
+     * @return Where&Rules
+     */
     public function shouldOnlyDependOnComponents(string ...$componentNames);
 }