From 734f1633dea25d87dc353674cda022388612dacd Mon Sep 17 00:00:00 2001 From: akarnokd Date: Wed, 9 May 2018 13:25:53 +0200 Subject: [PATCH 1/3] 2.x: Remove excessive whitespaces from generated javadocs on build --- build.gradle | 1 + gradle/javadoc_cleanup.gradle | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 gradle/javadoc_cleanup.gradle diff --git a/build.gradle b/build.gradle index f3f16d4eb4..d39826e76d 100644 --- a/build.gradle +++ b/build.gradle @@ -369,3 +369,4 @@ if (rootProject.hasProperty("releaseMode")) { } } +apply from: file("gradle/javadoc_cleanup.gradle") diff --git a/gradle/javadoc_cleanup.gradle b/gradle/javadoc_cleanup.gradle new file mode 100644 index 0000000000..75e89c3ade --- /dev/null +++ b/gradle/javadoc_cleanup.gradle @@ -0,0 +1,22 @@ +// remove the excessive whitespaces between method arguments in the javadocs +task javadocCleanup(dependsOn: "javadoc") doLast { + fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/Flowable.html')); + fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/Observable.html')); + fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/Single.html')); + fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/Maybe.html')); + fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/Completable.html')); + + fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/flowables/ConnectableFlowable.html')); + fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/observables/ConnectableObservable.html')); +} + +def fixJavadocFile(file) { + println("Cleaning up: " + file); + String fileContents = file.getText('UTF-8') + + fileContents = fileContents.replaceAll(",\\s{4,}", ",\n "); + + file.setText(fileContents, 'UTF-8'); +} + +build.dependsOn javadocCleanup \ No newline at end of file From 303c15a147651664d4b0547cd808aed276e793bd Mon Sep 17 00:00:00 2001 From: akarnokd Date: Wed, 9 May 2018 13:51:56 +0200 Subject: [PATCH 2/3] Fix html before javadocJar, fix other space patterns --- gradle/javadoc_cleanup.gradle | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/gradle/javadoc_cleanup.gradle b/gradle/javadoc_cleanup.gradle index 75e89c3ade..604817ee06 100644 --- a/gradle/javadoc_cleanup.gradle +++ b/gradle/javadoc_cleanup.gradle @@ -14,9 +14,17 @@ def fixJavadocFile(file) { println("Cleaning up: " + file); String fileContents = file.getText('UTF-8') + // lots of spaces after the previous method argument fileContents = fileContents.replaceAll(",\\s{4,}", ",\n "); + // lots of spaces after the @NonNull annotations + fileContents = fileContents.replaceAll("@NonNull\\s{4,}", "@NonNull "); + + // lots of spaces after the @Nullable annotations + fileContents = fileContents.replaceAll("@Nullable\\s{4,}", "@Nullable "); + file.setText(fileContents, 'UTF-8'); } +javadocJar.dependsOn javadocCleanup build.dependsOn javadocCleanup \ No newline at end of file From fce6aff210b70c2bfa2ead0a4c57fe613a1fd62b Mon Sep 17 00:00:00 2001 From: akarnokd Date: Wed, 9 May 2018 14:56:57 +0200 Subject: [PATCH 3/3] Fix replay subject/processor html --- gradle/javadoc_cleanup.gradle | 3 +++ 1 file changed, 3 insertions(+) diff --git a/gradle/javadoc_cleanup.gradle b/gradle/javadoc_cleanup.gradle index 604817ee06..32db33b963 100644 --- a/gradle/javadoc_cleanup.gradle +++ b/gradle/javadoc_cleanup.gradle @@ -8,6 +8,9 @@ task javadocCleanup(dependsOn: "javadoc") doLast { fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/flowables/ConnectableFlowable.html')); fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/observables/ConnectableObservable.html')); + + fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/subjects/ReplaySubject.html')); + fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/processors/ReplayProcessor.html')); } def fixJavadocFile(file) {