mirror of
https://github.com/PaperMC/Paper.git
synced 2025-03-02 11:22:01 +01:00
Configure javadoc overview and doc-files copying
closes #7462 Co-authored-by: Jake Potrebic <jake.m.potrebic@gmail.com>
This commit is contained in:
parent
c95b80ccc1
commit
90efa70509
@ -43,21 +43,7 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
|
|||||||
// Paper end
|
// Paper end
|
||||||
|
|
||||||
compileOnly("org.apache.maven:maven-resolver-provider:3.8.4")
|
compileOnly("org.apache.maven:maven-resolver-provider:3.8.4")
|
||||||
@@ -0,0 +0,0 @@ tasks.jar {
|
@@ -0,0 +0,0 @@ tasks.withType<Javadoc> {
|
||||||
}
|
|
||||||
|
|
||||||
tasks.withType<Javadoc> {
|
|
||||||
+ inputs.files(apiAndDocs)
|
|
||||||
+ .ignoreEmptyDirectories()
|
|
||||||
+ .withPropertyName(apiAndDocs.name + "-configuration")
|
|
||||||
+ doFirst {
|
|
||||||
+ (options as CoreJavadocOptions).addStringOption(
|
|
||||||
+ "sourcepath",
|
|
||||||
+ apiAndDocs.resolvedConfiguration.files.joinToString(separator = File.pathSeparator, transform = File::getPath)
|
|
||||||
+ )
|
|
||||||
+ }
|
|
||||||
(options as StandardJavadocDocletOptions).links(
|
|
||||||
"https://guava.dev/releases/31.0.1-jre/api/docs/",
|
|
||||||
"https://javadoc.io/doc/org.yaml/snakeyaml/1.30/",
|
"https://javadoc.io/doc/org.yaml/snakeyaml/1.30/",
|
||||||
"https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/", // Paper - we don't want Java 5 annotations
|
"https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/", // Paper - we don't want Java 5 annotations
|
||||||
"https://javadoc.io/doc/net.md-5/bungeecord-chat/1.16-R0.4/",
|
"https://javadoc.io/doc/net.md-5/bungeecord-chat/1.16-R0.4/",
|
||||||
@ -68,7 +54,18 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
|
|||||||
+ "https://jd.adventure.kyori.net/text-serializer-plain/$adventureVersion/",
|
+ "https://jd.adventure.kyori.net/text-serializer-plain/$adventureVersion/",
|
||||||
+ // Paper end
|
+ // Paper end
|
||||||
)
|
)
|
||||||
}
|
|
||||||
|
+ inputs.files(apiAndDocs).ignoreEmptyDirectories().withPropertyName(apiAndDocs.name + "-configuration")
|
||||||
|
+ doFirst {
|
||||||
|
+ options.addStringOption(
|
||||||
|
+ "sourcepath",
|
||||||
|
+ apiAndDocs.resolvedConfiguration.files.joinToString(separator = File.pathSeparator, transform = File::getPath)
|
||||||
|
+ )
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
// workaround for https://github.com/gradle/gradle/issues/4046
|
||||||
|
inputs.dir("src/main/javadoc").withPropertyName("javadoc-sourceset")
|
||||||
|
doLast {
|
||||||
diff --git a/src/main/java/co/aikar/timings/TimingsReportListener.java b/src/main/java/co/aikar/timings/TimingsReportListener.java
|
diff --git a/src/main/java/co/aikar/timings/TimingsReportListener.java b/src/main/java/co/aikar/timings/TimingsReportListener.java
|
||||||
index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
|
index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
|
||||||
--- a/src/main/java/co/aikar/timings/TimingsReportListener.java
|
--- a/src/main/java/co/aikar/timings/TimingsReportListener.java
|
||||||
|
@ -38,11 +38,11 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
|
|||||||
testImplementation("org.hamcrest:hamcrest-library:1.3")
|
testImplementation("org.hamcrest:hamcrest-library:1.3")
|
||||||
testImplementation("org.ow2.asm:asm-tree:9.2")
|
testImplementation("org.ow2.asm:asm-tree:9.2")
|
||||||
@@ -0,0 +0,0 @@ tasks.withType<Javadoc> {
|
@@ -0,0 +0,0 @@ tasks.withType<Javadoc> {
|
||||||
(options as StandardJavadocDocletOptions).links(
|
options.links(
|
||||||
"https://guava.dev/releases/31.0.1-jre/api/docs/",
|
"https://guava.dev/releases/31.0.1-jre/api/docs/",
|
||||||
"https://javadoc.io/doc/org.yaml/snakeyaml/1.30/",
|
"https://javadoc.io/doc/org.yaml/snakeyaml/1.30/",
|
||||||
- "https://javadoc.io/doc/org.jetbrains/annotations-java5/23.0.0/",
|
- "https://javadoc.io/doc/org.jetbrains/annotations-java5/23.0.0/",
|
||||||
+ "https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/", // Paper - we don't want Java 5 annotations
|
+ "https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/", // Paper - we don't want Java 5 annotations
|
||||||
"https://javadoc.io/doc/net.md-5/bungeecord-chat/1.16-R0.4/",
|
"https://javadoc.io/doc/net.md-5/bungeecord-chat/1.16-R0.4/",
|
||||||
)
|
)
|
||||||
}
|
|
||||||
|
@ -90,12 +90,26 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
|
|||||||
+}
|
+}
|
||||||
+
|
+
|
||||||
+tasks.withType<Javadoc> {
|
+tasks.withType<Javadoc> {
|
||||||
+ (options as StandardJavadocDocletOptions).links(
|
+ val options = options as StandardJavadocDocletOptions
|
||||||
|
+ options.overview = "src/main/javadoc/overview.html"
|
||||||
|
+ options.isDocFilesSubDirs = true
|
||||||
|
+ options.links(
|
||||||
+ "https://guava.dev/releases/31.0.1-jre/api/docs/",
|
+ "https://guava.dev/releases/31.0.1-jre/api/docs/",
|
||||||
+ "https://javadoc.io/doc/org.yaml/snakeyaml/1.30/",
|
+ "https://javadoc.io/doc/org.yaml/snakeyaml/1.30/",
|
||||||
+ "https://javadoc.io/doc/org.jetbrains/annotations-java5/23.0.0/",
|
+ "https://javadoc.io/doc/org.jetbrains/annotations-java5/23.0.0/",
|
||||||
+ "https://javadoc.io/doc/net.md-5/bungeecord-chat/1.16-R0.4/",
|
+ "https://javadoc.io/doc/net.md-5/bungeecord-chat/1.16-R0.4/",
|
||||||
+ )
|
+ )
|
||||||
|
+
|
||||||
|
+ // workaround for https://github.com/gradle/gradle/issues/4046
|
||||||
|
+ inputs.dir("src/main/javadoc").withPropertyName("javadoc-sourceset")
|
||||||
|
+ doLast {
|
||||||
|
+ copy {
|
||||||
|
+ from("src/main/javadoc") {
|
||||||
|
+ include("**/doc-files/**")
|
||||||
|
+ }
|
||||||
|
+ into("build/docs/javadoc")
|
||||||
|
+ }
|
||||||
|
+ }
|
||||||
+}
|
+}
|
||||||
diff --git a/pom.xml b/pom.xml
|
diff --git a/pom.xml b/pom.xml
|
||||||
deleted file mode 100644
|
deleted file mode 100644
|
||||||
|
Loading…
Reference in New Issue
Block a user