onixbyte/onixbyte-bom
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(global): Improve documentation comments

Browse Source 
Enriched the content of the documentation to ensure every package and
class has proper documentation comments; Modified the formatting for
consistent and neat presentation.
This commit is contained in:
Zihlu Wang
2023-07-30 02:27:05 +08:00
parent 89837f78f3
commit 65daccf478
19 changed files with 616 additions and 186 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -1
View File
@@ -2,6 +2,9 @@
JDevKit is a Java Development Kit that offers a set of convenient tools for writing code efficiently.
## Modules
### `devkit-core`
The core module for `JDevKit`, by now, this module contains the commonly used classes of the whole `dev-kit`.
### `guid`
A module for generating globally unique IDs. It includes a facade interface and an implementation of GUID generation using the Snowflake algorithm. More globally unique ID generation modes will be added in the future.
@@ -52,7 +55,7 @@ implementation 'cn.org.codecrafters:$artifactId:$version'
If you want to check the available versions, please check out at our [official site]().
## Contribution
Contributions are welcome! If you encounter any issues or want to contribute to the project, please feel free to **[raise an issue]()** or **[submit a pull request]()**.
Contributions are welcome! If you encounter any issues or want to contribute to the project, please feel free to **[raise an issue](https://github.com/CodeCraftersCN/jdevkit/issues/new)** or **[submit a pull request]()**.
## License
This project is licensed under the [Apache License 2.0](LICENSE).