Skip to content
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

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

Merged
merged 2 commits into from
Sep 12, 2020

Conversation

akarnokd
Copy link
Member

There is a long-standing bug in either javac or javadocs that results in certain annotations to be put into the HTML twice:

image

https://bugs.openjdk.java.net/browse/JDK-8175533

Looks like it happens with certain @Documented annotations, but not others. The issue persists up to JDK 16 preview.

This PR adds a workaround to the existing HTML patching gradle task which removes such duplicates:

image

Sidenote: yes, the method return also duplicates @NonNull, but that's across HTML elements and is much harder to fix.

@akarnokd akarnokd added this to the 3.1 milestone Sep 11, 2020
@codecov
Copy link

codecov bot commented Sep 11, 2020

Codecov Report

Merging #7073 into 3.x will increase coverage by 0.02%.
The diff coverage is 100.00%.

Impacted file tree graph

@@             Coverage Diff              @@
##                3.x    #7073      +/-   ##
============================================
+ Coverage     99.52%   99.54%   +0.02%     
  Complexity     6669     6669              
============================================
  Files           742      742              
  Lines         47270    47275       +5     
  Branches       6373     6374       +1     
============================================
+ Hits          47044    47059      +15     
  Misses          102      102              
+ Partials        124      114      -10     
Impacted Files Coverage Δ Complexity Δ
.../main/java/io/reactivex/rxjava3/core/Flowable.java 100.00% <ø> (ø) 595.00 <0.00> (ø)
...ain/java/io/reactivex/rxjava3/core/Observable.java 100.00% <ø> (ø) 565.00 <0.00> (ø)
...a3/internal/jdk8/FlowableCollectWithCollector.java 100.00% <100.00%> (ø) 2.00 <1.00> (ø)
...ernal/jdk8/FlowableCollectWithCollectorSingle.java 100.00% <100.00%> (ø) 3.00 <1.00> (ø)
.../internal/jdk8/ObservableCollectWithCollector.java 100.00% <100.00%> (ø) 2.00 <1.00> (ø)
...nal/jdk8/ObservableCollectWithCollectorSingle.java 100.00% <100.00%> (ø) 3.00 <1.00> (ø)
...java3/internal/operators/flowable/FlowableMap.java 100.00% <100.00%> (ø) 3.00 <0.00> (ø)
...nternal/operators/observable/ObservableWindow.java 100.00% <100.00%> (+1.81%) 3.00 <0.00> (ø)
...tivex/rxjava3/internal/jdk8/ParallelCollector.java 91.74% <0.00%> (-6.43%) 2.00% <0.00%> (ø%)
.../internal/disposables/ListCompositeDisposable.java 98.00% <0.00%> (-2.00%) 34.00% <0.00%> (-1.00%)
... and 17 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1ff3cd6...6ae80f9. Read the comment docs.

@akarnokd akarnokd merged commit ffe2fcc into ReactiveX:3.x Sep 12, 2020
@akarnokd akarnokd deleted the JavadocDocumentedDuplicationFix branch September 12, 2020 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant