From 5b0e3ed6361a169f95529f495bf237dc8fadccef Mon Sep 17 00:00:00 2001 From: crazywhalecc Date: Sat, 17 Dec 2022 16:42:47 +0000 Subject: [PATCH] update api docs --- docs/.vuepress/api.js | 2 +- docs/api/ZM/Annotation/AnnotationMap.md | 4 ++-- docs/api/ZM/Annotation/AnnotationParser.md | 8 ++++---- docs/api/ZM/Utils/EasterEgg.md | 17 +++++++++++++++++ docs/api/ZM/ZMApplication.md | 17 +++++++++++++++++ 5 files changed, 41 insertions(+), 7 deletions(-) create mode 100644 docs/api/ZM/Utils/EasterEgg.md create mode 100644 docs/api/ZM/ZMApplication.md diff --git a/docs/.vuepress/api.js b/docs/.vuepress/api.js index c9b1c359..146d766f 100644 --- a/docs/.vuepress/api.js +++ b/docs/.vuepress/api.js @@ -1 +1 @@ -module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/ConsoleApplication","ZM/InstantApplication"]},{"title":"ZM/Annotation","collapsable":true,"children":["ZM/Annotation/AnnotationHandler","ZM/Annotation/AnnotationMap","ZM/Annotation/AnnotationParser","ZM/Annotation/AnnotationBase"]},{"title":"ZM/Command","collapsable":true,"children":["ZM/Command/InitCommand","ZM/Command/Command","ZM/Command/ProxyServerCommand","ZM/Command/CheckConfigCommand","ZM/Command/BuildCommand"]},{"title":"ZM/Command/Server","collapsable":true,"children":["ZM/Command/Server/ServerStartCommand","ZM/Command/Server/ServerCommand"]},{"title":"ZM/Config","collapsable":true,"children":["ZM/Config/ZMConfig","ZM/Config/ConfigTracer"]},{"title":"ZM/Container","collapsable":true,"children":["ZM/Container/ContainerServicesProvider","ZM/Container/BoundMethod","ZM/Container/WorkerContainer","ZM/Container/Container"]},{"title":"ZM/Context","collapsable":true,"children":["ZM/Context/Context"]},{"title":"ZM/Event","collapsable":true,"children":["ZM/Event/EventProvider","ZM/Event/EventDispatcher"]},{"title":"ZM/Event/Listener","collapsable":true,"children":["ZM/Event/Listener/MasterEventListener","ZM/Event/Listener/ManagerEventListener","ZM/Event/Listener/HttpEventListener","ZM/Event/Listener/WorkerEventListener","ZM/Event/Listener/SignalListener","ZM/Event/Listener/WSEventListener"]},{"title":"ZM/Middleware","collapsable":true,"children":["ZM/Middleware/MiddlewareHandler","ZM/Middleware/Pipeline"]},{"title":"ZM/Process","collapsable":true,"children":["ZM/Process/ProcessStateManager"]},{"title":"ZM/Store","collapsable":true,"children":["ZM/Store/FileSystem"]},{"title":"ZM/Store/Database","collapsable":true,"children":["ZM/Store/Database/DBWrapper","ZM/Store/Database/DBStatement","ZM/Store/Database/DBPool","ZM/Store/Database/DBStatementWrapper","ZM/Store/Database/DBConnection","ZM/Store/Database/DBQueryBuilder"]},{"title":"ZM/Store/Lock","collapsable":true,"children":["ZM/Store/Lock/FileLock"]},{"title":"ZM/Utils","collapsable":true,"children":["ZM/Utils/ReflectionUtil","ZM/Utils/ZMUtil","ZM/Utils/HttpUtil"]}] \ No newline at end of file +module.exports = [{"title":"ZM","collapsable":true,"children":["ZM/ZMApplication","ZM/ConsoleApplication"]},{"title":"ZM/Annotation","collapsable":true,"children":["ZM/Annotation/AnnotationHandler","ZM/Annotation/AnnotationMap","ZM/Annotation/AnnotationParser","ZM/Annotation/AnnotationBase"]},{"title":"ZM/Command","collapsable":true,"children":["ZM/Command/InitCommand","ZM/Command/Command","ZM/Command/ProxyServerCommand","ZM/Command/CheckConfigCommand","ZM/Command/BuildCommand"]},{"title":"ZM/Command/Server","collapsable":true,"children":["ZM/Command/Server/ServerStartCommand","ZM/Command/Server/ServerCommand"]},{"title":"ZM/Config","collapsable":true,"children":["ZM/Config/ZMConfig","ZM/Config/ConfigTracer"]},{"title":"ZM/Container","collapsable":true,"children":["ZM/Container/ContainerServicesProvider","ZM/Container/BoundMethod","ZM/Container/WorkerContainer","ZM/Container/Container"]},{"title":"ZM/Context","collapsable":true,"children":["ZM/Context/Context"]},{"title":"ZM/Event","collapsable":true,"children":["ZM/Event/EventProvider","ZM/Event/EventDispatcher"]},{"title":"ZM/Event/Listener","collapsable":true,"children":["ZM/Event/Listener/MasterEventListener","ZM/Event/Listener/ManagerEventListener","ZM/Event/Listener/HttpEventListener","ZM/Event/Listener/WorkerEventListener","ZM/Event/Listener/SignalListener","ZM/Event/Listener/WSEventListener"]},{"title":"ZM/Middleware","collapsable":true,"children":["ZM/Middleware/MiddlewareHandler","ZM/Middleware/Pipeline"]},{"title":"ZM/Process","collapsable":true,"children":["ZM/Process/ProcessStateManager"]},{"title":"ZM/Store","collapsable":true,"children":["ZM/Store/FileSystem"]},{"title":"ZM/Store/Database","collapsable":true,"children":["ZM/Store/Database/DBWrapper","ZM/Store/Database/DBStatement","ZM/Store/Database/DBPool","ZM/Store/Database/DBStatementWrapper","ZM/Store/Database/DBConnection","ZM/Store/Database/DBQueryBuilder"]},{"title":"ZM/Store/Lock","collapsable":true,"children":["ZM/Store/Lock/FileLock"]},{"title":"ZM/Utils","collapsable":true,"children":["ZM/Utils/EasterEgg","ZM/Utils/ReflectionUtil","ZM/Utils/ZMUtil","ZM/Utils/HttpUtil"]}] \ No newline at end of file diff --git a/docs/api/ZM/Annotation/AnnotationMap.md b/docs/api/ZM/Annotation/AnnotationMap.md index 20740566..3342efab 100644 --- a/docs/api/ZM/Annotation/AnnotationMap.md +++ b/docs/api/ZM/Annotation/AnnotationMap.md @@ -3,7 +3,7 @@ ## loadAnnotationByParser ```php -public function loadAnnotationByParser(ZM\Annotation\AnnotationParser $parser): mixed +public function loadAnnotationByParser(ZM\Annotation\AnnotationParser $parser): void ``` ### 描述 @@ -20,4 +20,4 @@ public function loadAnnotationByParser(ZM\Annotation\AnnotationParser $parser): | 类型 | 描述 | | ---- | ----------- | -| mixed | | +| void | | diff --git a/docs/api/ZM/Annotation/AnnotationParser.md b/docs/api/ZM/Annotation/AnnotationParser.md index 3639ee9d..1517fa0e 100644 --- a/docs/api/ZM/Annotation/AnnotationParser.md +++ b/docs/api/ZM/Annotation/AnnotationParser.md @@ -50,7 +50,7 @@ public function addSpecialParser(string $class_name, callable $callback): mixed ## parseAll ```php -public function parseAll(): mixed +public function parseAll(): void ``` ### 描述 @@ -61,7 +61,7 @@ public function parseAll(): mixed | 类型 | 描述 | | ---- | ----------- | -| mixed | | +| void | | ## generateAnnotationList @@ -167,7 +167,7 @@ public function getAnnotationMap(): array ## addRouteAnnotation ```php -public function addRouteAnnotation(ZM\Annotation\Http\Route $vss): mixed +public function addRouteAnnotation(ZM\Annotation\Http\Route $vss): void ``` ### 描述 @@ -184,4 +184,4 @@ public function addRouteAnnotation(ZM\Annotation\Http\Route $vss): mixed | 类型 | 描述 | | ---- | ----------- | -| mixed | | +| void | | diff --git a/docs/api/ZM/Utils/EasterEgg.md b/docs/api/ZM/Utils/EasterEgg.md new file mode 100644 index 00000000..edf460bf --- /dev/null +++ b/docs/api/ZM/Utils/EasterEgg.md @@ -0,0 +1,17 @@ +# ZM\Utils\EasterEgg + +## checkFrameworkPermissionCall + +```php +public function checkFrameworkPermissionCall(): string +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| string | | diff --git a/docs/api/ZM/ZMApplication.md b/docs/api/ZM/ZMApplication.md new file mode 100644 index 00000000..57acd4bb --- /dev/null +++ b/docs/api/ZM/ZMApplication.md @@ -0,0 +1,17 @@ +# ZM\ZMApplication + +## run + +```php +public function run(): mixed +``` + +### 描述 + +作者很懒，什么也没有说 + +### 返回 + +| 类型 | 描述 | +| ---- | ----------- | +| mixed | |