fix phpdoc

bearsunday · Dec 21, 2014 · dfd74b7 · dfd74b7
1 parent 2f1284e
commit dfd74b7
Show file tree

Hide file tree

Showing 14 changed files with 31 additions and 22 deletions.
diff --git a/src/Extension/Application/AbstractApp.php b/src/Extension/Application/AbstractApp.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the *** package
+ * This file is part of the BEAR.Sunday package
  *
  * @license http://opensource.org/licenses/bsd-license.php BSD
  */
@@ -37,6 +37,7 @@ class AbstractApp implements AppInterface
      * @param RouterInterface   $router
      * @param TransferInterface $responder
      * @param ResourceInterface $resource
+     * @param ErrorInterface    $error
      */
     public function __construct(
         RouterInterface $router,

diff --git a/src/Extension/Representation/README.md b/src/Extension/Representation/README.md
@@ -3,8 +3,4 @@
 
 ### interface
 
-BEAR\Resource\RenderInterface
-
-### file:
-
-vendor/bear/resource/BEAR/Resource/RenderInterface
+[BEAR\Resource\RenderInterface](https://github.com/koriym/BEAR.Resource/blob/develop-2/src/RenderInterface.php)
diff --git a/src/Extension/Router/RouterMatch.php b/src/Extension/Router/RouterMatch.php
@@ -23,6 +23,9 @@ class RouterMatch
      */
     public $query = [];
 
+    /**
+     * @return string
+     */
     public function __toString()
     {
         $querySymbol = $this->query ? '?' : '';

diff --git a/src/Inject/PsrLoggerInject.php b/src/Inject/PsrLoggerInject.php
@@ -16,8 +16,6 @@ trait PsrLoggerInject
     private $logger;
 
     /**
-     * PSR Logger setter
-     *
      * @param LoggerInterface $logger
      *
      * @Ray\Di\Di\Inject

diff --git a/src/Module/Constant/NamedModule.php b/src/Module/Constant/NamedModule.php
@@ -24,6 +24,9 @@ public function __construct(array $names)
         parent::__construct();
     }
 
+    /**
+     * {@inheritdoc}
+     */
     protected function configure()
     {
         foreach ($this->names as $annotatedWith => $instance) {

diff --git a/src/Module/SundayModule.php b/src/Module/SundayModule.php
@@ -11,9 +11,9 @@
 use BEAR\Sunday\Module\Cache\DoctrineCacheModule;
 use BEAR\Sunday\Module\Resource\ResourceModule;
 use BEAR\Sunday\Provide\Application\MinApp;
+use BEAR\Sunday\Provide\Error\ErrorModule;
 use BEAR\Sunday\Provide\Router\RouterModule;
 use BEAR\Sunday\Provide\Transfer\HttpResponderModule;
-use BEAR\Sunday\Provide\Error\ErrorModule;
 use Ray\Di\AbstractModule;
 
 class SundayModule extends AbstractModule

diff --git a/src/Provide/Application/AppModule.php b/src/Provide/Application/AppModule.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the *** package
+ * This file is part of the BEAR.Sunday package
  *
  * @license http://opensource.org/licenses/bsd-license.php BSD
  */

diff --git a/src/Provide/Application/MinApp.php b/src/Provide/Application/MinApp.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the *** package
+ * This file is part of the BEAR.Sunday package
  *
  * @license http://opensource.org/licenses/bsd-license.php BSD
  */

diff --git a/src/Provide/Error/VndError.php b/src/Provide/Error/VndError.php
@@ -9,7 +9,6 @@
 use BEAR\Resource\Code;
 use BEAR\Resource\Exception\BadRequestException as BadRequest;
 use BEAR\Resource\Exception\ResourceNotFoundException as NotFound;
-use BEAR\Resource\Exception\ServerErrorException as ServerError;
 use BEAR\Resource\Exception\ServerErrorException;
 use BEAR\Sunday\Extension\Error\ErrorInterface;
 use BEAR\Sunday\Extension\Router\RouterMatch as Request;
@@ -44,6 +43,11 @@ public function handle(\Exception $e, Request $request)
         return $this->serverError($e, $request);
     }
 
+    /**
+     * @param \Exception $e
+     *
+     * @return ErrorPage
+     */
     private function codeError(\Exception $e)
     {
         $code = $e->getCode();
@@ -57,6 +61,8 @@ private function codeError(\Exception $e)
     /**
      * @param \Exception $e
      * @param Request    $request
+     *
+     * @return ErrorPage
      */
     private function serverError(\Exception $e, Request $request)
     {

diff --git a/src/Provide/Representation/RepresentationModule.php b/src/Provide/Representation/RepresentationModule.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the *** package
+ * This file is part of the BEAR.Sunday package
  *
  * @license http://opensource.org/licenses/bsd-license.php BSD
  */

diff --git a/src/Provide/Transfer/HttpResponder.php b/src/Provide/Transfer/HttpResponder.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the *** package
+ * This file is part of the BEAR.Sunday package
  *
  * @license http://opensource.org/licenses/bsd-license.php BSD
  */
@@ -11,6 +11,9 @@
 
 class HttpResponder implements TransferInterface
 {
+    /**
+     * {@inheritdoc}
+     */
     public function __invoke(ResourceObject $resourceObject)
     {
         // code

diff --git a/src/Provide/Transfer/JsonResponder.php b/src/Provide/Transfer/JsonResponder.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the *** package
+ * This file is part of the BEAR.Sunday package
  *
  * @license http://opensource.org/licenses/bsd-license.php BSD
  */
@@ -11,6 +11,9 @@
 
 class JsonResponder implements TransferInterface
 {
+    /**
+     * {@inheritdoc}
+     */
     public function __invoke(ResourceObject $resourceObject)
     {
         // code

diff --git a/tests/Provide/Error/VndErrorTest.php b/tests/Provide/Error/VndErrorTest.php
@@ -1,9 +1,5 @@
 <?php
-/**
- * This file is part of the BEAR.Sunday package
- *
- * @license http://opensource.org/licenses/bsd-license.php BSD
- */
+
 namespace BEAR\Sunday\Provide\Error;
 
 use BEAR\Resource\Exception\BadRequestException;

diff --git a/tests/multiple_apps_Test.php b/tests/multiple_apps_Test.php
@@ -2,10 +2,10 @@
 
 namespace BEAR\Sunday;
 
-use Ray\Di\Injector;
+use BEAR\Resource\Request;
 use BEAR\Resource\ResourceInterface;
 use FakeVendor\HelloWorldX\Module\AppModule;
-use BEAR\Resource\Request;
+use Ray\Di\Injector;
 
 class multiple_apps_Test extends \PHPUnit_Framework_TestCase
 {