From 7c066af1163557d63d24921d1eaa4138ee1f5d3e Mon Sep 17 00:00:00 2001 From: fankesyooni Date: Wed, 27 Sep 2023 21:41:36 +0800 Subject: [PATCH] docs: update api docs --- docs-source/src/.vuepress/configs/template.ts | 1 + .../yukireflection/YukiReflection.md | 46 ++++-------- .../highcapable/yukireflection/log/YLog.md | 75 +++++++++++++++++++ .../yukireflection/YukiReflection.md | 46 ++++-------- .../highcapable/yukireflection/log/YLog.md | 67 +++++++++++++++++ 5 files changed, 173 insertions(+), 62 deletions(-) create mode 100644 docs-source/src/en/api/public/com/highcapable/yukireflection/log/YLog.md create mode 100644 docs-source/src/zh-cn/api/public/com/highcapable/yukireflection/log/YLog.md diff --git a/docs-source/src/.vuepress/configs/template.ts b/docs-source/src/.vuepress/configs/template.ts index a5045bd..ce8ef2a 100644 --- a/docs-source/src/.vuepress/configs/template.ts +++ b/docs-source/src/.vuepress/configs/template.ts @@ -23,6 +23,7 @@ const navigationLinks = { baseApiPath + 'type/android/ViewTypeFactory', baseApiPath + 'type/java/VariableTypeFactory', baseApiPath + 'type/defined/DefinedTypeFactory', + baseApiPath + 'log/YLog', baseApiPath + 'factory/ReflectionFactory', baseApiPath + 'finder/members/MethodFinder', baseApiPath + 'finder/members/ConstructorFinder', diff --git a/docs-source/src/en/api/public/com/highcapable/yukireflection/YukiReflection.md b/docs-source/src/en/api/public/com/highcapable/yukireflection/YukiReflection.md index db6f3b0..b4c5a72 100644 --- a/docs-source/src/en/api/public/com/highcapable/yukireflection/YukiReflection.md +++ b/docs-source/src/en/api/public/com/highcapable/yukireflection/YukiReflection.md @@ -86,23 +86,29 @@ object Configs > 对 API 相关功能的配置类。 -### debugTag - field +### debugLog - method ```kotlin:no-line-numbers -var debugTag: String +inline fun debugLog(initiate: YLog.Configs.() -> Unit) ``` **Change Records** +`v1.0.3` `added` + +**Function Illustrate** + +> 配置 `YLog.Configs` 相关参数。 + +

debugTag - field

+ +**Change Records** + `v1.0.0` `first` -**Function Illustrate** +`v1.0.3` `deprecated` -> 这是一个调试日志的全局标识。 - -默认文案为 `YukiReflection`。 - -你可以修改为你自己的文案。 +请迁移到 `debugLog` ### isDebug - field @@ -120,28 +126,6 @@ var isDebug: Boolean 默认不启用，启用后将交由日志输出管理器打印详细日志 (例如反射查找功能的耗时) 到控制台。 -请过滤 `debugTag` 即可找到每条日志。 - -### isEnableLogs - field - -```kotlin:no-line-numbers -var isEnableLogs: Boolean -``` - -**Change Records** - -`v1.0.3` `added` - -**Function Illustrate** - -> 是否启用调试日志的输出功能。 - -::: warning - -关闭后将会停用 **YukiReflection** 对全部日志的输出，同时 **isDebug** 将不再有效。 - -::: -

isAllowPrintingLogs - field

**Change Records** @@ -150,7 +134,7 @@ var isEnableLogs: Boolean `v1.0.3` `deprecated` -请迁移到 `isEnableLogs` +请迁移到 `debugLog`

isEnableMemberCache - field

diff --git a/docs-source/src/en/api/public/com/highcapable/yukireflection/log/YLog.md b/docs-source/src/en/api/public/com/highcapable/yukireflection/log/YLog.md new file mode 100644 index 0000000..7c769f1 --- /dev/null +++ b/docs-source/src/en/api/public/com/highcapable/yukireflection/log/YLog.md @@ -0,0 +1,75 @@ +--- +pageClass: code-page +--- + +::: warning + +The English translation of this page has not been completed, you are welcome to contribute translations to us. + +You can use the **Chrome Translation Plugin** to translate entire pages for reference. + +::: + +# YLog - object + +```kotlin:no-line-numbers +object YLog +``` + +**Change Records** + +`v1.0.3` `added` + +**Function Illustrate** + +> 全局 Log 管理类。 + +## Configs - object + +```kotlin:no-line-numbers +object Configs +``` + +**Change Records** + +`v1.0.3` `added` + +**Function Illustrate** + +> 配置 `YLog`。 + +### tag - field + +```kotlin:no-line-numbers +var tag: String +``` + +**Change Records** + +`v1.0.3` `added` + +**Function Illustrate** + +> 这是一个调试日志的全局标识。 + +默认文案为 `YukiReflection`。 + +你可以修改为你自己的文案。 + +### isEnable - field + +```kotlin:no-line-numbers +var isEnable: Boolean +``` + +**Change Records** + +`v1.0.3` `added` + +**Function Illustrate** + +> 是否启用调试日志的输出功能。 + +关闭后将会停用 `YukiReflection` 对全部日志的输出。 + +当 `isEnable` 关闭后 `YukiReflection.Configs.isDebug` 也将同时关闭。 \ No newline at end of file diff --git a/docs-source/src/zh-cn/api/public/com/highcapable/yukireflection/YukiReflection.md b/docs-source/src/zh-cn/api/public/com/highcapable/yukireflection/YukiReflection.md index 5bb3ea3..b38c21f 100644 --- a/docs-source/src/zh-cn/api/public/com/highcapable/yukireflection/YukiReflection.md +++ b/docs-source/src/zh-cn/api/public/com/highcapable/yukireflection/YukiReflection.md @@ -78,23 +78,29 @@ object Configs > 对 API 相关功能的配置类。 -### debugTag - field +### debugLog - method ```kotlin:no-line-numbers -var debugTag: String +inline fun debugLog(initiate: YLog.Configs.() -> Unit) ``` **变更记录** +`v1.0.3` `新增` + +**功能描述** + +> 配置 `YLog.Configs` 相关参数。 + +

debugTag - field

+ +**变更记录** + `v1.0.0` `添加` -**功能描述** +`v1.0.3` `作废` -> 这是一个调试日志的全局标识。 - -默认文案为 `YukiReflection`。 - -你可以修改为你自己的文案。 +请迁移到 `debugLog` ### isDebug - field @@ -112,28 +118,6 @@ var isDebug: Boolean 默认不启用，启用后将交由日志输出管理器打印详细日志 (例如反射查找功能的耗时) 到控制台。 -请过滤 `debugTag` 即可找到每条日志。 - -### isEnableLogs - field - -```kotlin:no-line-numbers -var isEnableLogs: Boolean -``` - -**变更记录** - -`v1.0.3` `新增` - -**功能描述** - -> 是否启用调试日志的输出功能。 - -::: warning - -关闭后将会停用 **YukiReflection** 对全部日志的输出，同时 **isDebug** 将不再有效。 - -::: -

isAllowPrintingLogs - field

**变更记录** @@ -142,7 +126,7 @@ var isEnableLogs: Boolean `v1.0.3` `作废` -请迁移到 `isEnableLogs` +请迁移到 `debugLog`

isEnableMemberCache - field

diff --git a/docs-source/src/zh-cn/api/public/com/highcapable/yukireflection/log/YLog.md b/docs-source/src/zh-cn/api/public/com/highcapable/yukireflection/log/YLog.md new file mode 100644 index 0000000..7820635 --- /dev/null +++ b/docs-source/src/zh-cn/api/public/com/highcapable/yukireflection/log/YLog.md @@ -0,0 +1,67 @@ +--- +pageClass: code-page +--- + +# YLog - object + +```kotlin:no-line-numbers +object YLog +``` + +**变更记录** + +`v1.0.3` `新增` + +**功能描述** + +> 全局 Log 管理类。 + +## Configs - object + +```kotlin:no-line-numbers +object Configs +``` + +**变更记录** + +`v1.0.3` `新增` + +**功能描述** + +> 配置 `YLog`。 + +### tag - field + +```kotlin:no-line-numbers +var tag: String +``` + +**变更记录** + +`v1.0.3` `新增` + +**功能描述** + +> 这是一个调试日志的全局标识。 + +默认文案为 `YukiReflection`。 + +你可以修改为你自己的文案。 + +### isEnable - field + +```kotlin:no-line-numbers +var isEnable: Boolean +``` + +**变更记录** + +`v1.0.3` `新增` + +**功能描述** + +> 是否启用调试日志的输出功能。 + +关闭后将会停用 `YukiReflection` 对全部日志的输出。 + +当 `isEnable` 关闭后 `YukiReflection.Configs.isDebug` 也将同时关闭。 \ No newline at end of file