Re-generate API docs

This commit is contained in:
crazywhalecc
2022-04-01 18:48:48 +08:00
committed by sunxyw
parent ae0cf5e3d7
commit 9fa1079248
39 changed files with 488 additions and 220 deletions

View File

@@ -17,6 +17,7 @@ public function yieldByWS(int $timeout, array $hang, array $compare): mixed
| timeout | int | |
| hang | array | |
| compare | array | |
### 返回
| 类型 | 描述 |

View File

@@ -100,6 +100,7 @@ public function getDataFolder(string $second): null|array|false|mixed|string
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| second | string | |
### 返回
| 类型 | 描述 |
@@ -123,6 +124,7 @@ public function saveToJson(mixed $filename, mixed $file_array): false|int
| -------- | ---- | ----------- |
| filename | mixed | |
| file_array | mixed | |
### 返回
| 类型 | 描述 |
@@ -145,6 +147,7 @@ public function loadFromJson(mixed $filename): null|mixed
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| filename | mixed | |
### 返回
| 类型 | 描述 |
@@ -169,6 +172,7 @@ public function scanDirFiles(mixed $dir, bool|string $relative, bool $recursive)
| dir | mixed | |
| relative | bool|string | |
| recursive | bool | |
### 返回
| 类型 | 描述 |
@@ -191,6 +195,7 @@ public function isRelativePath(mixed $path): bool
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| path | mixed | |
### 返回
| 类型 | 描述 |

View File

@@ -19,6 +19,7 @@ public function parseUri(mixed $request, mixed $response, mixed $uri, mixed $nod
| uri | mixed | |
| node | mixed | |
| params | mixed | |
### 返回
| 类型 | 描述 |
@@ -43,6 +44,7 @@ public function handleStaticPage(mixed $uri, Response|\Swoole\Http\Response $res
| uri | mixed | |
| response | Response|\Swoole\Http\Response | |
| settings | array | |
### 返回
| 类型 | 描述 |

View File

@@ -35,6 +35,7 @@ public function startExecute(ZM\Annotation\Cron\Cron $v, ZM\Event\EventDispatche
| v | ZM\Annotation\Cron\Cron | |
| dispatcher | ZM\Event\EventDispatcher | |
| cron | Cron\CronExpression | |
### 返回
| 类型 | 描述 |

View File

@@ -32,6 +32,7 @@ public function packModule(mixed $module): bool
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| module | mixed | |
### 返回
| 类型 | 描述 |
@@ -55,6 +56,7 @@ public function unpackModule(mixed $module, array $options): array|false
| -------- | ---- | ----------- |
| module | mixed | |
| options | array | |
### 返回
| 类型 | 描述 |

View File

@@ -16,6 +16,7 @@ Worker 进程间通信触发的动作类型函数
| -------- | ---- | ----------- |
| src_worker_id | mixed | |
| data | mixed | |
### 返回
| 类型 | 描述 |
@@ -40,6 +41,7 @@ public function sendActionToWorker(mixed $worker_id, mixed $action, mixed $data)
| worker_id | mixed | |
| action | mixed | |
| data | mixed | |
### 返回
| 类型 | 描述 |

View File

@@ -16,6 +16,7 @@ public function downloadCQImage(mixed $msg, null $path): array|false
| -------- | ---- | ----------- |
| msg | mixed | |
| path | null | |
### 返回
| 类型 | 描述 |
@@ -38,6 +39,7 @@ public function containsImage(mixed $msg): bool
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| msg | mixed | |
### 返回
| 类型 | 描述 |
@@ -64,6 +66,7 @@ type == 2 : 返回图片的 http://xxx CQ 码(默认为 /images/ 路径就是
| -------- | ---- | ----------- |
| file | mixed | |
| type | int | |
### 返回
| 类型 | 描述 |
@@ -86,6 +89,7 @@ public function splitCommand(mixed $msg): array|string[]
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| msg | mixed | |
### 返回
| 类型 | 描述 |
@@ -109,6 +113,7 @@ public function matchCommand(mixed $msg, mixed $obj): ZM\Entity\MatchResult
| -------- | ---- | ----------- |
| msg | mixed | |
| obj | mixed | |
### 返回
| 类型 | 描述 |
@@ -132,6 +137,7 @@ public function addShortCommand(mixed $command, string $reply): mixed
| -------- | ---- | ----------- |
| command | mixed | |
| reply | string | |
### 返回
| 类型 | 描述 |
@@ -156,6 +162,7 @@ public function strToArray(mixed $msg, false $trim_text, bool $ignore_space): ar
| msg | mixed | |
| trim_text | false | |
| ignore_space | bool | |
### 返回
| 类型 | 描述 |
@@ -179,6 +186,7 @@ public function arrayToStr(array $array): string
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| array | array | |
### 返回
| 类型 | 描述 |

View File

@@ -15,6 +15,7 @@ public function signalMaster(Swoole\Server $server): mixed
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| server | Swoole\Server | |
### 返回
| 类型 | 描述 |
@@ -55,6 +56,7 @@ public function signalWorker(mixed $worker_id, Swoole\Server $server): mixed
| -------- | ---- | ----------- |
| worker_id | mixed | |
| server | Swoole\Server | |
### 返回
| 类型 | 描述 |

View File

@@ -15,6 +15,7 @@ public function executeCommand(string $cmd): bool
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| cmd | string | |
### 返回
| 类型 | 描述 |
@@ -88,6 +89,7 @@ public function call(mixed $it): mixed
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| it | mixed | |
### 返回
| 类型 | 描述 |
@@ -110,6 +112,7 @@ public function level(mixed $it): mixed
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| it | mixed | |
### 返回
| 类型 | 描述 |
@@ -132,6 +135,7 @@ public function bc(mixed $it): mixed
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| it | mixed | |
### 返回
| 类型 | 描述 |
@@ -154,6 +158,7 @@ public function echoI(mixed $it): mixed
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| it | mixed | |
### 返回
| 类型 | 描述 |

View File

@@ -3,13 +3,19 @@
## stop
```php
public function stop(): mixed
public function stop(mixed $error_exit): mixed
```
### 描述
作者很懒,什么也没有说
### 参数
| 名称 | 类型 | 描述 |
| -------- | ---- | ----------- |
| error_exit | mixed | |
### 返回
| 类型 | 描述 |
@@ -69,6 +75,7 @@ public function getClassesPsr4(mixed $dir, mixed $base_namespace, null|mixed $ru
| base_namespace | mixed | |
| rule | null|mixed | |
| return_path_value | bool | |
### 返回
| 类型 | 描述 |