Merge pull request #169 from koriym/phpdoc

Document the public bindings provided by modules
bearsunday · Mar 27, 2022 · 064debe · 064debe
2 parents 5d9b77b + e060cc8
commit 064debe
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 0 deletions.
diff --git a/src/Module/SundayModule.php b/src/Module/SundayModule.php
@@ -11,6 +11,9 @@
 use BEAR\Sunday\Provide\Transfer\HttpResponderModule;
 use Ray\Di\AbstractModule;
 
+/**
+ * Provides BEAR.Sunday base bindings
+ */
 class SundayModule extends AbstractModule
 {
     protected function configure(): void

diff --git a/src/Provide/Router/RouterModule.php b/src/Provide/Router/RouterModule.php
@@ -8,6 +8,14 @@
 use BEAR\Sunday\Extension\Router\RouterInterface;
 use Ray\Di\AbstractModule;
 
+/**
+ * Provides RouterInterface and derived bindings
+ *
+ * The following bindings are provided:
+ *
+ *  RouterInterface
+ *  -DefaultSchemeHost
+ */
 class RouterModule extends AbstractModule
 {
     protected function configure(): void

diff --git a/src/Provide/Transfer/HttpCacheModule.php b/src/Provide/Transfer/HttpCacheModule.php
@@ -8,6 +8,9 @@
 use BEAR\Sunday\Extension\Transfer\NullHttpCache;
 use Ray\Di\AbstractModule;
 
+/**
+ * Provides HttpCacheInterface bindings
+ */
 class HttpCacheModule extends AbstractModule
 {
     protected function configure(): void

diff --git a/src/Provide/Transfer/HttpResponderModule.php b/src/Provide/Transfer/HttpResponderModule.php
@@ -7,6 +7,15 @@
 use BEAR\Sunday\Extension\Transfer\TransferInterface;
 use Ray\Di\AbstractModule;
 
+/**
+ * Provides TransferInterface and derived bindings
+ *
+ * The following bindings are provided:
+ *
+ *  TransferInterface
+ *  HeaderInterface
+ *  ConditionalResponseInterface
+ */
 class HttpResponderModule extends AbstractModule
 {
     protected function configure(): void