Limework
/
RedisBungee
mirror of https://github.com/proxiodev/RedisBungee.git
2
0
Fork 0
Code Releases Activity

Javadocs links update (#67)

This commit is contained in:
mohammed Alteniji 2023-03-25 19:46:22 +04:00 committed by GitHub
parent b857bdb771
commit 47127c8520
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -17,7 +17,7 @@ Cluster mode compatibility in version 0.8.0:
If you are using static legacy method `RedisBungee#getPool()` it might fail in: If you are using static legacy method `RedisBungee#getPool()` it might fail in:
* if Cluster mode is enabled, due fact its Uses different classes * if Cluster mode is enabled, due fact its Uses different classes
* if JedisPool compatibility mode is disabled in the config due fact project internally switched to JedisPooled than Jedis * if JedisPool compatibility mode is disabled in the config due fact project internally switched to JedisPooled than Jedis
*
## License ## License
This project is distributed under Eclipse Public License 1.0 This project is distributed under Eclipse Public License 1.0
@ -133,7 +133,9 @@ then use any of these in your project.
``` ```
## Javadocs ## Javadocs
For current version [0.8.0](https://proxiodev.github.io/RedisBungee-JavaDocs/0.8.0-SNAPSHOT/) * API: https://ci.limework.net/RedisBungee/RedisBungee-API/build/docs/javadoc/
* Velocity: https://ci.limework.net/RedisBungee/RedisBungee-Velocity/build/docs/javadoc/
* Bungeecord: https://ci.limework.net/RedisBungee/RedisBungee-Bungee/build/docs/javadoc/
## Configuration ## Configuration

1
RedisBungee-API/build.gradle.kts
View File

@ -59,6 +59,7 @@ tasks {
"https://javadoc.io/doc/redis.clients/jedis/$jedisVersion/", // jedis "https://javadoc.io/doc/redis.clients/jedis/$jedisVersion/", // jedis
"https://guava.dev/releases/$guavaVersion/api/docs/" // guava "https://guava.dev/releases/$guavaVersion/api/docs/" // guava
) )
} }
test { test {

3
RedisBungee-Bungee/build.gradle.kts
View File

@ -29,12 +29,15 @@ java {
tasks { tasks {
withType<Javadoc> { withType<Javadoc> {
dependsOn(project(":RedisBungee-API").getTasksByName("javadoc", false))
val options = options as StandardJavadocDocletOptions val options = options as StandardJavadocDocletOptions
options.use() options.use()
options.isDocFilesSubDirs = true options.isDocFilesSubDirs = true
options.links( options.links(
"https://ci.md-5.net/job/BungeeCord/ws/api/target/apidocs/", // bungeecord api "https://ci.md-5.net/job/BungeeCord/ws/api/target/apidocs/", // bungeecord api
) )
val apiDocs = File(rootProject.projectDir, "RedisBungee-API/build/docs/javadoc")
options.linksOffline("https://ci.limework.net/RedisBungee/RedisBungee-API/build/docs/javadoc", apiDocs.path)
} }
runWaterfall { runWaterfall {
waterfallVersion("1.19") waterfallVersion("1.19")

3
RedisBungee-Velocity/build.gradle.kts
View File

@ -31,12 +31,15 @@ java {
tasks { tasks {
withType<Javadoc> { withType<Javadoc> {
dependsOn(project(":RedisBungee-API").getTasksByName("javadoc", false))
val options = options as StandardJavadocDocletOptions val options = options as StandardJavadocDocletOptions
options.use() options.use()
options.isDocFilesSubDirs = true options.isDocFilesSubDirs = true
options.links( options.links(
"https://jd.papermc.io/velocity/3.0.0/", // velocity api "https://jd.papermc.io/velocity/3.0.0/", // velocity api
) )
val apiDocs = File(rootProject.projectDir, "RedisBungee-API/build/docs/javadoc")
options.linksOffline("https://ci.limework.net/RedisBungee/RedisBungee-API/build/docs/javadoc", apiDocs.path)
} }
runVelocity { runVelocity {
velocityVersion("3.2.0-SNAPSHOT") velocityVersion("3.2.0-SNAPSHOT")