Skip to content

3.x: Patch out duplicate @NonNull annotation in generated javadocs #7073

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 12, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions gradle/javadoc_cleanup.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,31 @@ def fixJavadocFile(file) {
// lots of spaces after the @Nullable annotations
fileContents = fileContents.replaceAll("@Nullable</a>\\s{4,}", "@Nullable</a> ");

// javadoc bug: duplicates the link to @NonNull for some reason
def nonNullText1 = "<a href=\"../annotations/NonNull.html\" title=\"annotation in io.reactivex.rxjava3.annotations\">@NonNull</a>";

fileContents = fileContents.replace(nonNullText1 + " " + nonNullText1, nonNullText1);
fileContents = fileContents.replace(nonNullText1 + "\n " + nonNullText1, nonNullText1);
fileContents = fileContents.replace(nonNullText1 + "\r\n " + nonNullText1, nonNullText1);

def nonNullText2 = "<a href=\"../../../../io/reactivex/rxjava3/annotations/NonNull.html\" title=\"annotation in io.reactivex.rxjava3.annotations\">@NonNull</a>";
fileContents = fileContents.replace(nonNullText2 + " " + nonNullText2, nonNullText2);
fileContents = fileContents.replace(nonNullText2 + "\n " + nonNullText2, nonNullText2);
fileContents = fileContents.replace(nonNullText2 + "\r\n " + nonNullText2, nonNullText2);

// javadoc bug: duplicates the link to @Nullable for some reason
def nullableText1 = "<a href=\"../annotations/Nullable.html\" title=\"annotation in io.reactivex.rxjava3.annotations\">@Nullable</a>";

fileContents = fileContents.replace(nullableText1 + " " + nullableText1, nullableText1);
fileContents = fileContents.replace(nullableText1 + "\n " + nullableText1, nullableText1);
fileContents = fileContents.replace(nullableText1 + "\r\n " + nullableText1, nullableText1);

def nullableText2 = "<a href=\"../../../../io/reactivex/rxjava3/annotations/Nullable.html\" title=\"annotation in io.reactivex.rxjava3.annotations\">@Nullable</a>";

fileContents = fileContents.replace(nullableText2 + " " + nullableText2, nullableText2);
fileContents = fileContents.replace(nullableText2 + "\n " + nullableText2, nullableText2);
fileContents = fileContents.replace(nullableText2 + "\r\n " + nullableText2, nullableText2);

file.setText(fileContents, 'UTF-8');
}

Expand Down