Skip to content

Commit da4d942

Browse files
committed
docs:(fix): normalized
1 parent 5c09acd commit da4d942

File tree

10 files changed

+74
-74
lines changed

10 files changed

+74
-74
lines changed

docs-source/src/en/about/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
::: danger
66

7-
We will only maintain the latest API version, if you are using an outdate API version, you voluntarily renounce any possibility of maintenance.
7+
We will only maintain the latest API version. If you are using an outdated API version, you voluntarily renounce any possibility of maintenance.
88

99
:::
1010

docs-source/src/en/about/future.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
# Looking for Future
1+
# Looking Toward the Future
22

3-
> The future is bright and uncertain, let us look forward to the future development space of `KavaRef`.
3+
> The future is bright and uncertain, let us look forward to the future development potential of `KavaRef`.
44
55
## Future Plans
66

77
> Features that `KavaRef` may add later are included here.
88
9-
### Supports Class Filtering through ClassLoader
9+
### Support Class Filtering through ClassLoader
1010

1111
`KavaRef` currently only supports search and calls for reflection APIs such as `Method`, `Field`, and `Constructor`.
12-
In the future, the ability to filter `Class` by specified type `ClassLoader` may be supported in Java and Android platforms according to requirements.
12+
In the future, the ability to filter `Class` by specified `ClassLoader` type may be supported on Java and Android platforms according to requirements.
1313

14-
Currently, you can use [DexKit](https://github.com/LuckyPray/DexKit) to complete this requirement,
15-
which also supports more complex searches and calls of reflective APIs such as Method, Field, and Constructor.
14+
Currently, you can use [DexKit](https://github.com/LuckyPray/DexKit) to fulfill this requirement,
15+
which also supports more complex searches and calls for reflective APIs such as Method, Field, and Constructor.
1616

1717
### Automatically Generate Reflection Code
1818

19-
**This is a feature that has been initially established in [YukiReflection](https://github.com/HighCapable/YukiReflection), and `KavaRef` is ready to continue to implement it in the possible time in the future.**
19+
**This is a feature that was initially established in [YukiReflection](https://github.com/HighCapable/YukiReflection), and `KavaRef` is ready to continue implementing it at some point in the future.**
2020

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

@@ -66,7 +66,7 @@ MyClass().resolve().apply {
6666
}
6767
```
6868

69-
The function to be implemented at present can be directly defined as the following Kotlin class using the reflection function.
69+
The function to be implemented can currently be directly defined as the following Kotlin class using the reflection functionality.
7070

7171
> The following example
7272
@@ -90,7 +90,7 @@ class MyClass {
9090
}
9191
```
9292

93-
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.
93+
Then we can directly call this defined Kotlin class to implement the reflection functionality, and the API will automatically generate the reflection code according to the annotations.
9494

9595
> The following example
9696
@@ -109,6 +109,6 @@ MyClass().also {
109109

110110
::: tip
111111

112-
The above functions may change after the actual release, and the functions of the actual version shall prevail.
112+
The above functions may change after the actual release, and the features of the actual version shall prevail.
113113

114114
:::

docs-source/src/en/config/migration.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -73,30 +73,30 @@ myClass.current().method {
7373
</div>
7474
</div>
7575

76-
`KavaRef` starts reflection at any time, you need to use `resolve()` to create a reflection scope.
77-
You no longer directly extend the related `method` and `constructor` methods to avoid contaminating their scope.
76+
`KavaRef` starts reflection at any time; you need to use `resolve()` to create a reflection scope.
77+
You no longer directly extend the related `method` and `constructor` methods to avoid polluting their scope.
7878

7979
`KavaRef` provides the `asResolver()` method to directly reference the reflection scope of the instance object,
80-
avoiding contamination caused by the creation of uncontrollable instance objects by the `current()` method in `YukiReflection`.
80+
avoiding pollution caused by the creation of uncontrollable instance objects by the `current()` method in `YukiReflection`.
8181

82-
`KavaRef` abandons the "Finder" design concept and uses the "Filter" design concept to obtain reflected results.
83-
"Find" is no longer a finding, but a "filtering".
82+
`KavaRef` abandons the "Finder" design concept and uses the "Filter" design concept to obtain reflection results.
83+
"Find" is no longer finding, but "filtering".
8484

85-
`KavaRef` canceled the `YukiReflection` defined in the resulting instance whether the `Member` obtained is a multiple or a single design scheme,
85+
`KavaRef` canceled the design scheme defined in `YukiReflection` for determining whether the `Member` obtained in the resulting instance is multiple or single,
8686
and directly returns the entire `List<MemberResolver>`.
87-
The example you see above uses `firstMethod` to get the first match `MethodResolver`,
88-
if you need to get all matches, you can change to `method`.
87+
The example you see above uses `firstMethod` to get the first matching `MethodResolver`.
88+
If you need to get all matches, you can change to `method`.
8989

90-
The conditional method name of `KavaRef` in `MethodCondition` has been modified from abbreviation
91-
such as `param` before `YukiReflection` to `parameters` to more in line with the naming habit of Java reflection API.
90+
The conditional method name in `MethodCondition` of `KavaRef` has been modified from abbreviations
91+
such as `param` used previously in `YukiReflection` to `parameters` to better align with the naming conventions of the Java reflection API.
9292

93-
`KavaRef` no longer provides the `param(...).order()` function in the condition, because this function itself is unstable.
94-
`KavaRef` now uses an iterator for filtering, and the bytecode will no longer be in order, and the bytecode should not be filtered in order.
95-
You can use `firstMethod`, `firstField`, or `lastMethod`, `lastField`, etc. to get the first or last match result.
93+
`KavaRef` no longer provides the `param(...).order()` function in conditions, because this function itself is unstable.
94+
`KavaRef` now uses an iterator for filtering, and the bytecode will no longer be in order, nor should bytecode be filtered by order.
95+
You can use `firstMethod`, `firstField`, or `lastMethod`, `lastField`, etc. to get the first or last matching result.
9696

97-
`KavaRef` renames the `get(instance)` method to `of(instance)` because `get(...)` may be confused with the `get(...)` usage of `Field` and is not semantic,
98-
At the same time, `get(instance)` is no longer getting the `MethodFinder.Result.Instance` instance from something like `MethodFinder.Result`,
99-
but uses `of(instance)` to always operate and set the instance object to `MemberResolver`.
97+
`KavaRef` renames the `get(instance)` method to `of(instance)` because `get(...)` may be confused with the `get(...)` usage of `Field` and lacks semantic clarity.
98+
At the same time, `get(instance)` no longer gets the `MethodFinder.Result.Instance` instance from something like `MethodFinder.Result`,
99+
but uses `of(instance)` to consistently operate and set the instance object to `MemberResolver`.
100100

101101
Methods such as `string()`, `int()`, etc. in `MethodFinder.Result.Instance` have been removed in `KavaRef`.
102102
You can directly use `get<String>()`, `get<Int>()`, `invoke<String>(...)`, `invoke<Int>(...)`, etc. to get or call the corresponding type results.

docs-source/src/en/config/processor-resolvers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
> Here are some third-party Member resolvers for reference and use.
44
>
5-
> Please read [Custom Resolver](../library/kavaref-core.md#custom-resolver) for usage.
5+
> Please read [Custom Resolver](../library/kavaref-core.md#custom-resolver) for usage instructions.
66
77
## AndroidHiddenApiBypass
88

99
[Project URL](https://github.com/LSPosed/AndroidHiddenApiBypass)
1010

11-
> LSPass: Bypass restrictions on non-SDK interfaces
11+
> LSPosed: Bypass restrictions on non-SDK interfaces
1212
1313
```kotlin
1414
class AndroidHiddenApiBypassResolver : MemberProcessor.Resolver() {
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# R8 & Proguard Obfuscate
1+
# R8 & ProGuard Obfuscation
22

3-
> In most scenarios, Android application installation packages can compress volumes through obfuscation.
3+
> In most scenarios, Android application installation packages can reduce size through obfuscation.
44
> Here is a configuration method for obfuscation rules.
55
66
`KavaRef` does not require any additional configuration of obfuscation rules in Android projects.

docs-source/src/en/guide/home.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Introduce
1+
# Introduction
22

33
> `KavaRef` is a modern Java reflection API implemented using Kotlin.
44
@@ -10,37 +10,37 @@ reflection.
1010
The project icon is designed by [MaiTungTM](https://github.com/Lagrio) and is named from **K**otlinJ**avaRef**lection, meaning Java reflection
1111
implemented using Kotlin.
1212

13-
It was firstborn in the [YukiHookAPI](https://github.com/HighCapable/YukiHookAPI), and was later decoupled into
13+
It was first born in the [YukiHookAPI](https://github.com/HighCapable/YukiHookAPI), and was later decoupled into
1414
the [YukiReflection](https://github.com/HighCapable/YukiReflection) project.
1515

16-
As you can see, now `KavaRef` is a completely new set of APIs completely refactored with the design idea of `YukiReflection`,
16+
As you can see, `KavaRef` is now a completely new set of APIs, completely refactored with the design ideas of `YukiReflection`,
1717
which has no affiliation and will replace `YukiReflection` as a new reflection solution.
1818

1919
If you are using `YukiReflection` or the `YukiHookAPI` project related to it, you can refer to [here](../config/migration) to migrate the reflection API to `KavaRef`.
2020

2121
## Usage
2222

23-
`KavaRef` is built in Kotlin **lambda** syntax with Java Builder style.
23+
`KavaRef` is built with Kotlin **lambda** syntax in a Java Builder style.
2424

25-
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.
25+
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 with a more human-friendly language.
2626

2727
## Skill Requirements
2828

29-
You must be proficient in Java's native reflection APIs, understand Java's class loading mechanisms, bytecode structures, and how they are used in Kotlin (if you are using Kotlin).
29+
You should be proficient with Java's native reflection APIs, understand Java's class loading mechanisms, bytecode structures, and how they are used in Kotlin (if you are using Kotlin).
3030

3131
## Language Requirement
3232

33-
It is recommended to use Kotlin. API code composition also supports Java,
34-
but in pure Java projects `KavaRef` may not be able to play its full functionality and syntactic sugar advantages.
33+
It is recommended to use Kotlin. API composition also supports Java,
34+
but in pure Java projects, `KavaRef` may not be able to demonstrate its full functionality and syntactic sugar advantages.
3535

36-
All the demo sample code in the documentation will be described first using Kotlin.
37-
If you don't know how to use Kotlin at all, you may not be able to experience and use the functionality of `KavaRef` more fully.
36+
All the demo sample code in the documentation will be described using Kotlin first.
37+
If you don't know how to use Kotlin at all, you may not be able to fully experience and use the functionality of `KavaRef`.
3838

3939
## Contribution
4040

4141
The maintenance of this project is inseparable from the support and contributions of all developers.
4242

4343
This project is currently in its early stages, and there may still be some problems or lack of functions you need.
4444

45-
If possible, feel free to submit a PR to contribute features you think are needed to this project or goto [GitHub Issues](repo://issues)
45+
If possible, feel free to submit a PR to contribute features you think are needed to this project or go to [GitHub Issues](repo://issues)
4646
to make suggestions to us.

docs-source/src/en/guide/quick-start.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
55
## Project Requirements
66

7-
The project needs to be created using `IntelliJ IDEA` or `Android Studio` and be of type Java or Android
8-
project and have integrated Kotlin environment dependencies.
7+
The project needs to be created using `IntelliJ IDEA` or `Android Studio` and should be a Java or Android
8+
project with integrated Kotlin environment dependencies.
99

1010
- IntelliJ IDEA (It is recommended to get the latest version [from here](https://www.jetbrains.com/idea))
1111

@@ -93,5 +93,5 @@ Click the corresponding module below to view detailed feature descriptions.
9393

9494
## Demo
9595

96-
You can find some samples [here](repo://tree/main/samples) view the corresponding demo project to better understand how these functions work and quickly
96+
You can find some samples [here](repo://tree/main/samples) to view the corresponding demo projects to better understand how these functions work and quickly
9797
select the functions you need.

docs-source/src/en/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ features:
1414
details: A powerful, elegant, beautiful API built with Kotlin lambda can help you quickly implement bytecode filtering and reflection functions.
1515
- title: Fully Compatible
1616
details: Using native Java APIs to implement reflection functionality, it can be used on any Kotlin on JVM project, and it is no problem on Android.
17-
- title: Quickly Started
18-
details: Simple and easy to use it now! Do not need complex configuration and full development experience, Integrate dependencies and enjoy yourself.
17+
- title: Quick to Start
18+
details: Simple and easy to use right now! No complex configuration or extensive development experience required. Just integrate the dependencies and enjoy!
1919
footer: Apache-2.0 License | Copyright (C) 2019 HighCapable
2020
---
2121

0 commit comments

Comments
 (0)