Skip to content

Commit d13e5f9

Browse files
committed
优化注释,尽可能使用 inheritDoc 注释
1 parent 9fdb6ed commit d13e5f9

File tree

7 files changed

+9
-13
lines changed

7 files changed

+9
-13
lines changed

example/GrpcServer/Middleware/PoweredBy.php

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@
1515
class PoweredBy implements MiddlewareInterface
1616
{
1717
/**
18-
* Process an incoming server request and return a response, optionally delegating
19-
* response creation to a handler.
18+
* {@inheritDoc}
2019
*/
2120
public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
2221
{

example/Listener/OnServerCreateAfter.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
class OnServerCreateAfter implements IEventListener
1616
{
1717
/**
18-
* 事件处理方法.
18+
* {@inheritDoc}
1919
*/
2020
public function handle(EventParam $e): void
2121
{

example/Task/TestTask.php

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,7 @@
1414
class TestTask implements ITaskHandler
1515
{
1616
/**
17-
* 任务处理方法,返回的值会通过 finish 事件推送给 worker 进程.
18-
*
19-
* @return mixed
17+
* {@inheritDoc}
2018
*/
2119
public function handle(TaskParam $param, \Swoole\Server $server, int $taskId, int $workerId)
2220
{
@@ -26,9 +24,7 @@ public function handle(TaskParam $param, \Swoole\Server $server, int $taskId, in
2624
}
2725

2826
/**
29-
* 任务结束时触发.
30-
*
31-
* @param mixed $data
27+
* {@inheritDoc}
3228
*/
3329
public function finish(\Swoole\Server $server, int $taskId, $data): void
3430
{

src/grpc/Listener/WorkerExit.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
class WorkerExit implements IEventListener
2121
{
2222
/**
23-
* 事件处理方法.
23+
* {@inheritDoc}
2424
*/
2525
public function handle(EventParam $e): void
2626
{

src/grpc/Middleware/ActionMiddleware.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ class ActionMiddleware implements MiddlewareInterface
3939
private array $actionMethodParams = [];
4040

4141
/**
42-
* 处理方法.
42+
* {@inheritDoc}
4343
*/
4444
public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
4545
{

src/server/Error/DefaultGrpcErrorHandler.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ public function handle(\Throwable $throwable): bool
2929
{
3030
$response = $response->withTrailer('grpc-message', $this->getGrpcMessage($throwable));
3131
}
32+
/** @var \Imi\Server\Http\Message\Response $response */
3233
$response->send();
3334

3435
return false;

src/server/Server.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
class Server extends \Imi\Swoole\Server\Http\Server
1515
{
1616
/**
17-
* 创建 swoole 服务器对象
17+
* {@inheritDoc}
1818
*/
1919
protected function createServer(): void
2020
{
@@ -24,7 +24,7 @@ protected function createServer(): void
2424
}
2525

2626
/**
27-
* 从主服务器监听端口,作为子服务器.
27+
* {@inheritDoc}
2828
*/
2929
protected function createSubServer(): void
3030
{

0 commit comments

Comments
 (0)