优化注释，尽可能使用 inheritDoc 注释

imiphp · Oct 13, 2021 · d13e5f9 · d13e5f9
1 parent 9fdb6ed
commit d13e5f9
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 13 deletions.
diff --git a/example/GrpcServer/Middleware/PoweredBy.php b/example/GrpcServer/Middleware/PoweredBy.php
@@ -15,8 +15,7 @@
 class PoweredBy implements MiddlewareInterface
 {
     /**
-     * Process an incoming server request and return a response, optionally delegating
-     * response creation to a handler.
+     * {@inheritDoc}
      */
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
     {

diff --git a/example/Listener/OnServerCreateAfter.php b/example/Listener/OnServerCreateAfter.php
@@ -15,7 +15,7 @@
 class OnServerCreateAfter implements IEventListener
 {
     /**
-     * 事件处理方法.
+     * {@inheritDoc}
      */
     public function handle(EventParam $e): void
     {

diff --git a/example/Task/TestTask.php b/example/Task/TestTask.php
@@ -14,9 +14,7 @@
 class TestTask implements ITaskHandler
 {
     /**
-     * 任务处理方法，返回的值会通过 finish 事件推送给 worker 进程.
-     *
-     * @return mixed
+     * {@inheritDoc}
      */
     public function handle(TaskParam $param, \Swoole\Server $server, int $taskId, int $workerId)
     {
@@ -26,9 +24,7 @@ public function handle(TaskParam $param, \Swoole\Server $server, int $taskId, in
     }
 
     /**
-     * 任务结束时触发.
-     *
-     * @param mixed $data
+     * {@inheritDoc}
      */
     public function finish(\Swoole\Server $server, int $taskId, $data): void
     {

diff --git a/src/grpc/Listener/WorkerExit.php b/src/grpc/Listener/WorkerExit.php
@@ -20,7 +20,7 @@
 class WorkerExit implements IEventListener
 {
     /**
-     * 事件处理方法.
+     * {@inheritDoc}
      */
     public function handle(EventParam $e): void
     {

diff --git a/src/grpc/Middleware/ActionMiddleware.php b/src/grpc/Middleware/ActionMiddleware.php
@@ -39,7 +39,7 @@ class ActionMiddleware implements MiddlewareInterface
     private array $actionMethodParams = [];
 
     /**
-     * 处理方法.
+     * {@inheritDoc}
      */
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
     {

diff --git a/src/server/Error/DefaultGrpcErrorHandler.php b/src/server/Error/DefaultGrpcErrorHandler.php
@@ -29,6 +29,7 @@ public function handle(\Throwable $throwable): bool
         {
             $response = $response->withTrailer('grpc-message', $this->getGrpcMessage($throwable));
         }
+        /** @var \Imi\Server\Http\Message\Response $response */
         $response->send();
 
         return false;

diff --git a/src/server/Server.php b/src/server/Server.php
@@ -14,7 +14,7 @@
 class Server extends \Imi\Swoole\Server\Http\Server
 {
     /**
-     * 创建 swoole 服务器对象
+     * {@inheritDoc}
      */
     protected function createServer(): void
     {
@@ -24,7 +24,7 @@ protected function createServer(): void
     }
 
     /**
-     * 从主服务器监听端口，作为子服务器.
+     * {@inheritDoc}
      */
     protected function createSubServer(): void
     {