From 9547b85f011a5ef1dfa1e53295d65d37dd996494 Mon Sep 17 00:00:00 2001 From: Andrew Katz Date: Thu, 18 Mar 2021 10:47:41 -0600 Subject: [PATCH 1/7] Add browseJavadoc, allow frames support --- build.gradle | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/build.gradle b/build.gradle index 493dc77f..87bbfdc5 100644 --- a/build.gradle +++ b/build.gradle @@ -231,15 +231,24 @@ aggregateJavadoc.options.encoding = "UTF-8" archived: https://web.archive.org/web/20210117193942/https://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html which, in turn, references this: https://github.com/GPars/GPars/blob/7cddf7cf2fec1fd66ef800edccfc03315d078a2b/build.gradle#L209 */ -if (JavaVersion.current().isJava8Compatible()) { +if (JavaVersion.current().isJava11Compatible()) { allprojects { tasks.withType(Javadoc) { - // options.addStringOption("Xdoclint:-html", "-quiet") options.addBooleanOption("Xdoclint:-html", true) + options.addBooleanOption("-frames", true) } } } +task browseJavadoc { + dependsOn javadoc + description "Browse javadoc" + group = "documentation" + doLast { + java.awt.Desktop.desktop.browse new URI(("file:///" << System.getProperty("user.dir").replace('\\','/') << "/build/docs/javadoc/index.html").toString()) + } +} + tasks.publish.dependsOn build publishing { From 722e3926368f2671af166a4c92b158ea295444a6 Mon Sep 17 00:00:00 2001 From: Andrew Katz Date: Thu, 18 Mar 2021 11:23:57 -0600 Subject: [PATCH 2/7] update gradle --- gradle/wrapper/gradle-wrapper.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 8988d1ba..23fb75b0 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists compileJava.options.encoding=UTF-8 \ No newline at end of file From 394a6cb00c554f773da32d68bb4e4ff251d278c4 Mon Sep 17 00:00:00 2001 From: Andrew Katz Date: Thu, 18 Mar 2021 11:28:15 -0600 Subject: [PATCH 3/7] Fix javadoc issue --- build.gradle | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/build.gradle b/build.gradle index 87bbfdc5..2099e678 100644 --- a/build.gradle +++ b/build.gradle @@ -231,15 +231,15 @@ aggregateJavadoc.options.encoding = "UTF-8" archived: https://web.archive.org/web/20210117193942/https://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html which, in turn, references this: https://github.com/GPars/GPars/blob/7cddf7cf2fec1fd66ef800edccfc03315d078a2b/build.gradle#L209 */ -if (JavaVersion.current().isJava11Compatible()) { - allprojects { - tasks.withType(Javadoc) { - options.addBooleanOption("Xdoclint:-html", true) - options.addBooleanOption("-frames", true) - } + +allprojects { + tasks.withType(Javadoc) { + options.addBooleanOption("Xdoclint:-html", JavaVersion.current().isJava11Compatible()) + options.addBooleanOption("-frames", JavaVersion.current().isJava11()) } } + task browseJavadoc { dependsOn javadoc description "Browse javadoc" @@ -259,4 +259,4 @@ publishing { artifact rootSources // Publish the output of the (root) sources task } } -} +} \ No newline at end of file From 98123df01a69b852965a552bf754e9bb11060e36 Mon Sep 17 00:00:00 2001 From: Andrew Katz Date: Sat, 20 Mar 2021 22:39:30 -0600 Subject: [PATCH 4/7] Generate javadoc for private --- build.gradle | 2 ++ 1 file changed, 2 insertions(+) diff --git a/build.gradle b/build.gradle index 2099e678..743f2b8d 100644 --- a/build.gradle +++ b/build.gradle @@ -236,6 +236,8 @@ allprojects { tasks.withType(Javadoc) { options.addBooleanOption("Xdoclint:-html", JavaVersion.current().isJava11Compatible()) options.addBooleanOption("-frames", JavaVersion.current().isJava11()) + options.memberLevel = JavadocMemberLevel.PRIVATE + options.encoding = "UTF-8" } } From 1474de7d5c86c7d85399059a67d6b30ba73c19c4 Mon Sep 17 00:00:00 2001 From: James Date: Tue, 23 Mar 2021 19:30:00 +0000 Subject: [PATCH 5/7] Switch back to gradle 6.7 --- gradle/wrapper/gradle-wrapper.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 23fb75b0..8988d1ba 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists compileJava.options.encoding=UTF-8 \ No newline at end of file From 3f6ae9686e825d3802d65f729638d9c234a02edc Mon Sep 17 00:00:00 2001 From: James Date: Tue, 23 Mar 2021 19:37:53 +0000 Subject: [PATCH 6/7] Don't duplicate allprojects directive; remove extra encoding option --- build.gradle | 46 ++++++++++++++++++++++------------------------ 1 file changed, 22 insertions(+), 24 deletions(-) diff --git a/build.gradle b/build.gradle index 743f2b8d..131fd5a6 100644 --- a/build.gradle +++ b/build.gradle @@ -43,6 +43,27 @@ allprojects { } } } + + tasks.withType(Javadoc) { + /* + Javadoc Fixes, part 3 + Since JDK13 the javadoc html validator was changed, making it impossible to have javadocs + that are valid on both pre-13 and post-13 java versions. + The original workaround was suggested here: https://bugs.openjdk.java.net/browse/JDK-8223552 + However, this workaround does not work for us since we are using aggregate-javadoc. + So, we are using a workaround for the workaround from: + original: https://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html + archived: https://web.archive.org/web/20210117193942/https://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html + which, in turn, references this: https://github.com/GPars/GPars/blob/7cddf7cf2fec1fd66ef800edccfc03315d078a2b/build.gradle#L209 + */ + options.addBooleanOption("Xdoclint:-html", JavaVersion.current().isJava11Compatible()) + + // Enable frames support if running on java 11 + options.addBooleanOption("-frames", JavaVersion.current().isJava11()) + + // Include private and protected in the javadocs + options.memberLevel = JavadocMemberLevel.PRIVATE + } } subprojects { @@ -216,32 +237,9 @@ tasks.test.finalizedBy rootTestReport, rootJacocoMergedReport, javadoc // Root build: also run aggregateJavadoc after javadoc to generate project-wide javadocs tasks.javadoc.finalizedBy aggregateJavadoc -// Javadoc fixes (pt. 2, see above entry in subprojects) +// Javadoc fixes (pt. 2, see above entries) aggregateJavadoc.options.encoding = "UTF-8" -/* - Javadoc Fixes, part 3 - - Since JDK13 the javadoc html validator was changed, making it impossible to have javadocs - that are valid on both pre-13 and post-13 java versions. - The original workaround was suggested here: https://bugs.openjdk.java.net/browse/JDK-8223552 - However, this workaround does not work for us since we are using aggregate-javadoc. - So, we are using a workaround for the workaround from: - original: https://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html - archived: https://web.archive.org/web/20210117193942/https://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html - which, in turn, references this: https://github.com/GPars/GPars/blob/7cddf7cf2fec1fd66ef800edccfc03315d078a2b/build.gradle#L209 - */ - -allprojects { - tasks.withType(Javadoc) { - options.addBooleanOption("Xdoclint:-html", JavaVersion.current().isJava11Compatible()) - options.addBooleanOption("-frames", JavaVersion.current().isJava11()) - options.memberLevel = JavadocMemberLevel.PRIVATE - options.encoding = "UTF-8" - } -} - - task browseJavadoc { dependsOn javadoc description "Browse javadoc" From 62c55f94dfe8db36a291cb19463f662cdf6c08c5 Mon Sep 17 00:00:00 2001 From: James Date: Tue, 23 Mar 2021 19:39:26 +0000 Subject: [PATCH 7/7] Add trailing newline --- build.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.gradle b/build.gradle index 131fd5a6..eed62ea5 100644 --- a/build.gradle +++ b/build.gradle @@ -259,4 +259,4 @@ publishing { artifact rootSources // Publish the output of the (root) sources task } } -} \ No newline at end of file +}