docs: update api docs

This commit is contained in:
2023-09-27 21:41:36 +08:00
parent bb9c38cde9
commit 7c066af116
5 changed files with 173 additions and 62 deletions

View File

@@ -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',

View File

@@ -86,23 +86,29 @@ object Configs
> 对 API 相关功能的配置类。
### debugTag <span class="symbol">- field</span>
### debugLog <span class="symbol">- method</span>
```kotlin:no-line-numbers
var debugTag: String
inline fun debugLog(initiate: YLog.Configs.() -> Unit)
```
**Change Records**
`v1.0.3` `added`
**Function Illustrate**
> 配置 `YLog.Configs` 相关参数。
<h3 class="deprecated">debugTag - field</h3>
**Change Records**
`v1.0.0` `first`
**Function Illustrate**
`v1.0.3` `deprecated`
> 这是一个调试日志的全局标识。
默认文案为 `YukiReflection`。
你可以修改为你自己的文案。
请迁移到 `debugLog`
### isDebug <span class="symbol">- field</span>
@@ -120,28 +126,6 @@ var isDebug: Boolean
默认不启用,启用后将交由日志输出管理器打印详细日志 (例如反射查找功能的耗时) 到控制台。
请过滤 `debugTag` 即可找到每条日志。
### isEnableLogs <span class="symbol">- field</span>
```kotlin:no-line-numbers
var isEnableLogs: Boolean
```
**Change Records**
`v1.0.3` `added`
**Function Illustrate**
> 是否启用调试日志的输出功能。
::: warning
关闭后将会停用 **YukiReflection** 对全部日志的输出,同时 **isDebug** 将不再有效。
:::
<h3 class="deprecated">isAllowPrintingLogs - field</h3>
**Change Records**
@@ -150,7 +134,7 @@ var isEnableLogs: Boolean
`v1.0.3` `deprecated`
请迁移到 `isEnableLogs`
请迁移到 `debugLog`
<h3 class="deprecated">isEnableMemberCache - field</h3>

View File

@@ -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 <span class="symbol">- object</span>
```kotlin:no-line-numbers
object YLog
```
**Change Records**
`v1.0.3` `added`
**Function Illustrate**
> 全局 Log 管理类。
## Configs <span class="symbol">- object</span>
```kotlin:no-line-numbers
object Configs
```
**Change Records**
`v1.0.3` `added`
**Function Illustrate**
> 配置 `YLog`。
### tag <span class="symbol">- field</span>
```kotlin:no-line-numbers
var tag: String
```
**Change Records**
`v1.0.3` `added`
**Function Illustrate**
> 这是一个调试日志的全局标识。
默认文案为 `YukiReflection`。
你可以修改为你自己的文案。
### isEnable <span class="symbol">- field</span>
```kotlin:no-line-numbers
var isEnable: Boolean
```
**Change Records**
`v1.0.3` `added`
**Function Illustrate**
> 是否启用调试日志的输出功能。
关闭后将会停用 `YukiReflection` 对全部日志的输出。
当 `isEnable` 关闭后 `YukiReflection.Configs.isDebug` 也将同时关闭。

View File

@@ -78,23 +78,29 @@ object Configs
> 对 API 相关功能的配置类。
### debugTag <span class="symbol">- field</span>
### debugLog <span class="symbol">- method</span>
```kotlin:no-line-numbers
var debugTag: String
inline fun debugLog(initiate: YLog.Configs.() -> Unit)
```
**变更记录**
`v1.0.3` `新增`
**功能描述**
> 配置 `YLog.Configs` 相关参数。
<h3 class="deprecated">debugTag - field</h3>
**变更记录**
`v1.0.0` `添加`
**功能描述**
`v1.0.3` `作废`
> 这是一个调试日志的全局标识。
默认文案为 `YukiReflection`。
你可以修改为你自己的文案。
请迁移到 `debugLog`
### isDebug <span class="symbol">- field</span>
@@ -112,28 +118,6 @@ var isDebug: Boolean
默认不启用,启用后将交由日志输出管理器打印详细日志 (例如反射查找功能的耗时) 到控制台。
请过滤 `debugTag` 即可找到每条日志。
### isEnableLogs <span class="symbol">- field</span>
```kotlin:no-line-numbers
var isEnableLogs: Boolean
```
**变更记录**
`v1.0.3` `新增`
**功能描述**
> 是否启用调试日志的输出功能。
::: warning
关闭后将会停用 **YukiReflection** 对全部日志的输出,同时 **isDebug** 将不再有效。
:::
<h3 class="deprecated">isAllowPrintingLogs - field</h3>
**变更记录**
@@ -142,7 +126,7 @@ var isEnableLogs: Boolean
`v1.0.3` `作废`
请迁移到 `isEnableLogs`
请迁移到 `debugLog`
<h3 class="deprecated">isEnableMemberCache - field</h3>

View File

@@ -0,0 +1,67 @@
---
pageClass: code-page
---
# YLog <span class="symbol">- object</span>
```kotlin:no-line-numbers
object YLog
```
**变更记录**
`v1.0.3` `新增`
**功能描述**
> 全局 Log 管理类。
## Configs <span class="symbol">- object</span>
```kotlin:no-line-numbers
object Configs
```
**变更记录**
`v1.0.3` `新增`
**功能描述**
> 配置 `YLog`。
### tag <span class="symbol">- field</span>
```kotlin:no-line-numbers
var tag: String
```
**变更记录**
`v1.0.3` `新增`
**功能描述**
> 这是一个调试日志的全局标识。
默认文案为 `YukiReflection`。
你可以修改为你自己的文案。
### isEnable <span class="symbol">- field</span>
```kotlin:no-line-numbers
var isEnable: Boolean
```
**变更记录**
`v1.0.3` `新增`
**功能描述**
> 是否启用调试日志的输出功能。
关闭后将会停用 `YukiReflection` 对全部日志的输出。
当 `isEnable` 关闭后 `YukiReflection.Configs.isDebug` 也将同时关闭。