Skip to content

Commit

Permalink
docs(style): optimize symbols
Browse files Browse the repository at this point in the history
  • Loading branch information
fankes committed Sep 23, 2023
1 parent 03206bb commit a89176d
Show file tree
Hide file tree
Showing 22 changed files with 36 additions and 36 deletions.
8 changes: 4 additions & 4 deletions docs-source/src/en/about/future.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
### Automatically Generate Reflection Code

Use `stub` to create a `Kotlin` class, and declare the parameters in it, as well as its different states in each version.
Use `stub` to create a Kotlin class, and declare the parameters in it, as well as its different states in each version.

For example, the `Java` class below is the target class we need to reflect.
For example, the Java class below is the target class we need to reflect.

> The following example
Expand Down Expand Up @@ -56,7 +56,7 @@ classOf<MyClass>().buildOf().current {
}
```

The function to be implemented at present can be directly defined as the following `Kotlin` class using the reflection function.
The function to be implemented at present can be directly defined as the following Kotlin class using the reflection function.

> The following example
Expand All @@ -80,7 +80,7 @@ class MyClass {
}
```

Then we can directly call this defined `Kotlin` class to implement the reflection function, and the API will automatically generate the reflection code according to the annotation.
Then we can directly call this defined Kotlin class to implement the reflection function, and the API will automatically generate the reflection code according to the annotation.

> The following example
Expand Down
2 changes: 1 addition & 1 deletion docs-source/src/en/api/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -1703,7 +1703,7 @@ field {
}
```

Expressing the type of `Boolean::class.javaPrimitiveType` in `Kotlin` is very long and inconvenient.
Expressing the type of `Boolean::class.javaPrimitiveType` in Kotlin is very long and inconvenient.

Therefore, `YukiReflection` encapsulates common type calls for developers, including Android related types and Java common types and **primitive type keywords**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,6 @@ inline fun configs(initiate: Configs.() -> Unit)

**Function Illustrate**

> `Configs` 类实现了一个 `lambda` 方法体。
> `Configs` 类实现了一个 **lambda** 方法体。
你可以轻松地调用它进行配置。
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ inline fun <reified T> classOf(loader: ClassLoader?, initialize: Boolean): Class
**Function Example**

我们要获取一个 `Class``Kotlin` 下不通过反射时应该这样做。
我们要获取一个 `Class` 在 Kotlin 下不通过反射时应该这样做。

> The following example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ inline fun result(initiate: Result.() -> Unit): Result
**Function Example**

你可以使用 `lambda` 形式创建 `Result` 类。
你可以使用 **lambda** 形式创建 `Result` 类。

> The following example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ inline fun result(initiate: Result.() -> Unit): Result
**Function Example**

你可以使用 `lambda` 形式创建 `Result` 类。
你可以使用 **lambda** 形式创建 `Result` 类。

> The following example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,7 @@ inline fun result(initiate: Result.() -> Unit): Result
**Function Example**

你可以使用 `lambda` 形式创建 `Result` 类。
你可以使用 **lambda** 形式创建 `Result` 类。

> The following example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ You can use the **Chrome Translation Plugin** to translate entire pages for refe

**Function Illustrate**

> 这是一个预置反射类型的常量类,主要为 `Java` 相关基本变量类型的 `Class` 内容,跟随版本更新会逐一进行增加。
> 这是一个预置反射类型的常量类,主要为 Java 相关基本变量类型的 `Class` 内容,跟随版本更新会逐一进行增加。
详情可 [点击这里](https://github.com/fankes/YukiReflection/blob/master/yukireflection/src/main/java/com/highcapable/yukireflection/type/java/VariableTypeFactory.kt) 进行查看。
2 changes: 1 addition & 1 deletion docs-source/src/en/config/api-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> The basic configuration method of `YukiReflection` is introduced here.
`YukiReflection` can be used directly without some complex configuration, and does not conflict with `Java`'s native Reflection API.
`YukiReflection` can be used directly without some complex configuration, and does not conflict with Java's native Reflection API.

You can configure some functions of `YukiReflection` before using it.

Expand Down
10 changes: 5 additions & 5 deletions docs-source/src/en/guide/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,31 @@
## Background

This is a set of simple and efficient Reflection API rebuilt based on `Java` native Reflection API using `Kotlin`.
This is a set of simple and efficient Reflection API rebuilt based on Java native Reflection API using Kotlin.

`YukiReflection` is also the core functionality that [YukiHookAPI](https://github.com/fankes/YukiHookAPI) is using.

The name is taken from ["ももくり" heroine Yuki Kurihara](https://www.bilibili.com/bangumi/play/ss5016).

## Usage

`YukiReflection` is fully built with `Kotlin` `lambda` syntax.
`YukiReflection` is fully built with Kotlin **lambda** syntax.

It can replace [Java's native Reflection API](https://www.oracle.com/technical-resources/articles/java/javareflection.html) and implement a more complete reflection solution in a more human-friendly language.

## Language Requirement

Please use `Kotlin`, the code composition of the API part is also compatible with `Java`, but the implementation of the basic reflection scene **may not be used at all**.
Please use Kotlin, the code composition of the API part is also compatible with Java, but the implementation of the basic reflection scene **may not be used at all**.

All Demo sample codes in the document will be described using `Kotlin`, if you don’t know how to use `Kotlin` at all, you may not be able to use `YukiReflection`.
All Demo sample codes in the document will be described using Kotlin, if you don’t know how to use Kotlin at all, you may not be able to use `YukiReflection`.

## Source of Inspiration

`YukiReflection` was originally the core function integrated in the [YukiHookAPI](https://github.com/fankes/YukiHookAPI) project, and now it is decoupled so that this Reflection API can be used in any Java and Android platform project.

Now, we only need to write a small amount of code to implement a simple reflection call.

With `Kotlin` elegant `lambda` and `YukiReflection`, you can make your reflection logic more beautiful and clear.
With Kotlin elegant **lambda** and `YukiReflection`, you can make your reflection logic more beautiful and clear.

> The following example
Expand Down
2 changes: 1 addition & 1 deletion docs-source/src/en/guide/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

## Project Requirements

The project needs to be created using `Android Studio` or `IntelliJ IDEA` and the type is an Java or Android project and the `Kotlin` environment dependency has been integrated.
The project needs to be created using `Android Studio` or `IntelliJ IDEA` and the type is an Java or Android project and the Kotlin environment dependency has been integrated.

## Integration Dependencies

Expand Down
8 changes: 4 additions & 4 deletions docs-source/src/zh-cn/about/future.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
### 自动生成反射代码

使用 `stub` 的方式创建一个 `Kotlin` 类,并声明其中的参数,以及其在各个版本中的不同状态。
使用 `stub` 的方式创建一个 Kotlin 类,并声明其中的参数,以及其在各个版本中的不同状态。

比如下面的这个 `Java` 类就是我们需要反射的目标类。
比如下面的这个 Java 类就是我们需要反射的目标类。

> 示例如下
Expand Down Expand Up @@ -56,7 +56,7 @@ classOf<MyClass>().buildOf().current {
}
```

目前要实现的功能是可以使用反射功能直接定义为如下 `Kotlin` 类。
目前要实现的功能是可以使用反射功能直接定义为如下 Kotlin 类。

> 示例如下
Expand All @@ -80,7 +80,7 @@ class MyClass {
}
```

然后我们就可以直接调用这个定义好的 `Kotlin` 类来实现反射功能,API 会根据注解自动生成反射代码。
然后我们就可以直接调用这个定义好的 Kotlin 类来实现反射功能,API 会根据注解自动生成反射代码。

> 示例如下
Expand Down
2 changes: 1 addition & 1 deletion docs-source/src/zh-cn/api/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -1646,7 +1646,7 @@ field {
}
```

`Kotlin` 中表达出 `Boolean::class.javaPrimitiveType` 这个类型的写法很长,感觉并不方便。
在 Kotlin 中表达出 `Boolean::class.javaPrimitiveType` 这个类型的写法很长,感觉并不方便。

因此,`YukiReflection` 为开发者封装了常见的类型调用,其中包含了 Android 的相关类型和 Java 的常见类型与**原始类型关键字**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,6 @@ inline fun configs(initiate: Configs.() -> Unit)

**功能描述**

> `Configs` 类实现了一个 `lambda` 方法体。
> `Configs` 类实现了一个 **lambda** 方法体。
你可以轻松地调用它进行配置。
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ inline fun <reified T> classOf(loader: ClassLoader?, initialize: Boolean): Class
**功能示例**

我们要获取一个 `Class``Kotlin` 下不通过反射时应该这样做。
我们要获取一个 `Class` 在 Kotlin 下不通过反射时应该这样做。

> 示例如下
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ inline fun result(initiate: Result.() -> Unit): Result
**功能示例**

你可以使用 `lambda` 形式创建 `Result` 类。
你可以使用 **lambda** 形式创建 `Result` 类。

> 示例如下
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ inline fun result(initiate: Result.() -> Unit): Result
**功能示例**

你可以使用 `lambda` 形式创建 `Result` 类。
你可以使用 **lambda** 形式创建 `Result` 类。

> 示例如下
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ inline fun result(initiate: Result.() -> Unit): Result
**功能示例**

你可以使用 `lambda` 形式创建 `Result` 类。
你可以使用 **lambda** 形式创建 `Result` 类。

> 示例如下
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ pageClass: code-page

**功能描述**

> 这是一个预置反射类型的常量类,主要为 `Java` 相关基本变量类型的 `Class` 内容,跟随版本更新会逐一进行增加。
> 这是一个预置反射类型的常量类,主要为 Java 相关基本变量类型的 `Class` 内容,跟随版本更新会逐一进行增加。
详情可 [点击这里](https://github.com/fankes/YukiReflection/blob/master/yukireflection/src/main/java/com/highcapable/yukireflection/type/java/VariableTypeFactory.kt) 进行查看。
2 changes: 1 addition & 1 deletion docs-source/src/zh-cn/config/api-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> 这里介绍了 `YukiReflection` 的基本配置方法。
`YukiReflection` 无需一些复杂的配置即可直接开始使用,且不会与 `Java` 原生的反射 API 冲突。
`YukiReflection` 无需一些复杂的配置即可直接开始使用,且不会与 Java 原生的反射 API 冲突。

你可以在使用之前对 `YukiReflection` 进行一些功能配置。

Expand Down
10 changes: 5 additions & 5 deletions docs-source/src/zh-cn/guide/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,31 @@
## 背景

这是一个使用 `Kotlin` 基于 `Java` 原生反射 API 重新打造的一套简洁、高效的反射 API。
这是一个使用 Kotlin 基于 Java 原生反射 API 重新打造的一套简洁、高效的反射 API。

`YukiReflection` 同时也是 [YukiHookAPI](https://github.com/fankes/YukiHookAPI) 正在使用的核心功能。

名称取自 [《ももくり》女主 栗原 雪(Yuki)](https://www.bilibili.com/bangumi/play/ss5016)

## 用途

`YukiReflection` 完全采用 `Kotlin` `lambda` 语法构建。
`YukiReflection` 完全采用 Kotlin **lambda** 语法构建。

它能取代 [Java 原生的反射 API](https://pdai.tech/md/java/basic/java-basic-x-reflection.html),使用更加人性化的语言实现一套更加完善的反射方案。

## 语言要求

请使用 `Kotlin`,API 部分代码构成同样兼容 `Java` 但基础反射场景的实现**可能完全无法使用**
请使用 Kotlin,API 部分代码构成同样兼容 Java 但基础反射场景的实现**可能完全无法使用**

文档全部的 Demo 示例代码都将使用 `Kotlin` 进行描述,如果你完全不会使用 `Kotlin` 那你将有可能无法使用 `YukiReflection`
文档全部的 Demo 示例代码都将使用 Kotlin 进行描述,如果你完全不会使用 Kotlin 那你将有可能无法使用 `YukiReflection`

## 灵感来源

`YukiReflection` 最初是集成在 [YukiHookAPI](https://github.com/fankes/YukiHookAPI) 项目中的核心功能,现在进行了解耦合,使得这套反射 API 可以在任何 Java 和 Android 平台的项目中使用。

现在,我们只需要编写少量的代码,就能实现一个简单的反射调用。

借助 `Kotlin` 优雅的 `lambda` 写法以及 `YukiReflection`,可以让你的反射逻辑更加美观清晰。
借助 Kotlin 优雅的 **lambda** 写法以及 `YukiReflection`,可以让你的反射逻辑更加美观清晰。

> 示例如下
Expand Down
2 changes: 1 addition & 1 deletion docs-source/src/zh-cn/guide/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

## 项目要求

项目需要使用 `Android Studio``IntelliJ IDEA` 创建且类型为 Java 或 Android 项目并已集成 `Kotlin` 环境依赖。
项目需要使用 `Android Studio``IntelliJ IDEA` 创建且类型为 Java 或 Android 项目并已集成 Kotlin 环境依赖。

### 集成依赖

Expand Down

0 comments on commit a89176d

Please sign in to comment.