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

imiphp · Oct 13, 2021 · 1f7cf9b · 1f7cf9b
1 parent 35b71d8
commit 1f7cf9b
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 13 deletions.
diff --git a/example/TCPServer/TCPServer/DataParser/JsonObjectEOFParser.php b/example/TCPServer/TCPServer/DataParser/JsonObjectEOFParser.php
@@ -7,9 +7,7 @@
 class JsonObjectEOFParser extends \Imi\Server\DataParser\JsonObjectParser
 {
     /**
-     * 编码为存储格式.
-     *
-     * @param mixed $data
+     * {@inheritDoc}
      */
     public function encode($data): string
     {

diff --git a/example/TCPServer/TCPServer/DataParser/JsonObjectFixedParser.php b/example/TCPServer/TCPServer/DataParser/JsonObjectFixedParser.php
@@ -7,9 +7,7 @@
 class JsonObjectFixedParser extends \Imi\Server\DataParser\JsonObjectParser
 {
     /**
-     * 编码为存储格式.
-     *
-     * @param mixed $data
+     * {@inheritDoc}
      */
     public function encode($data): string
     {
@@ -19,9 +17,7 @@ public function encode($data): string
     }
 
     /**
-     * 解码为php变量.
-     *
-     * @return mixed
+     * {@inheritDoc}
      */
     public function decode(string $data)
     {

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

diff --git a/src/Http/Middleware/SwooleTrackerMiddleware.php b/src/Http/Middleware/SwooleTrackerMiddleware.php
@@ -23,6 +23,9 @@ class SwooleTrackerMiddleware extends BaseMiddleware implements MiddlewareInterf
      */
     protected int $successStatusCode = StatusCode::OK;
 
+    /**
+     * {@inheritDoc}
+     */
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
     {
         // @phpstan-ignore-next-line

diff --git a/src/TCP/Middleware/SwooleTrackerMiddleware.php b/src/TCP/Middleware/SwooleTrackerMiddleware.php
@@ -34,7 +34,7 @@ public function __init(): void
     }
 
     /**
-     * @return mixed
+     * {@inheritDoc}
      */
     public function process(IReceiveData $data, IReceiveHandler $handler)
     {

diff --git a/src/UDP/Middleware/SwooleTrackerMiddleware.php b/src/UDP/Middleware/SwooleTrackerMiddleware.php
@@ -34,7 +34,7 @@ public function __init(): void
     }
 
     /**
-     * @return mixed
+     * {@inheritDoc}
      */
     public function process(IPacketData $data, IPacketHandler $handler)
     {

diff --git a/src/WebSocket/Middleware/SwooleTrackerMiddleware.php b/src/WebSocket/Middleware/SwooleTrackerMiddleware.php
@@ -34,7 +34,7 @@ public function __init(): void
     }
 
     /**
-     * @return mixed
+     * {@inheritDoc}
      */
     public function process(IFrame $frame, IMessageHandler $handler)
     {
-Original file line number
+Diff line change
@@ Expand Up / @@ -34,7 +34,7 @@ public function __init(): void @@
         }
         /**
-         * @return mixed
+         * {@inheritDoc}
          */
         public function process(IReceiveData $data, IReceiveHandler $handler)
         {
@@ Expand Down @@