docs: Quick Javadoc fixes. #6943

GPopZach · 2020-04-01T09:12:57Z

Added @code tag wherever < or > were used, also removed a few
self-closing

tags. Both of these issues cause errors with the latest
version of Javadoc.

Signed-off-by: Zachary Trant zach@graalonline.com

Added @code tag wherever < or > were used, also removed a few self-closing <p> tags. Both of these issues cause errors with the latest version of Javadoc. Signed-off-by: Zachary Trant <zach@graalonline.com>

akarnokd

These are internal or test files which are exempt from the JavaDocs generation.

akarnokd · 2020-04-01T09:19:20Z

src/main/java/io/reactivex/rxjava3/internal/fuseable/FuseToFlowable.java

+ * {@code Single<Integer> single = Flowable.range(1, 10).reduce((a, b) -> a + b);}
+ * {@code Flowable<Integer> flowable = single.toFlowable();}


These should be part of the same code block

akarnokd · 2020-04-01T09:19:35Z

src/main/java/io/reactivex/rxjava3/internal/fuseable/FuseToMaybe.java

+ * {@code Single<Integer> single = Maybe.just(1).isEmpty();}
+ * {@code Maybe<Integer> maybe = single.toMaybe();}


These should be part of the same code block.

akarnokd · 2020-04-01T09:19:51Z

src/main/java/io/reactivex/rxjava3/internal/fuseable/FuseToObservable.java

+ * {@code Single<Integer> single = Observable.range(1, 10).reduce((a, b) -> a + b);}
+ * {@code Observable<Integer> observable = single.toObservable();}


These should be part of the same code block.

akarnokd · 2020-04-01T09:21:02Z

src/main/java/io/reactivex/rxjava3/internal/schedulers/SchedulerWhen.java

@@ -53,7 +53,7 @@
 * thread pool:
 *
 * <pre>
- * Scheduler limitScheduler = Schedulers.computation().when(workers -> {
+ * {@code Scheduler limitScheduler = Schedulers.computation().when(workers ->} {


This breaks the formatting of the lambda body.

akarnokd · 2020-04-01T09:21:16Z

src/main/java/io/reactivex/rxjava3/internal/schedulers/SchedulerWhen.java

@@ -71,7 +71,7 @@
 * to the second.
 *
 * <pre>
- * Scheduler limitScheduler = Schedulers.computation().when(workers -> {
+ * {@code Scheduler limitScheduler = Schedulers.computation().when(workers ->} {


This breaks the formatting of the lambda body.

akarnokd · 2020-04-01T09:22:39Z

src/test/java/io/reactivex/rxjava3/observers/SerializedObserverTest.java

@@ -340,11 +340,11 @@ public void onNext(String t) {
     *
     * When using SynchronizedSubscriber we get this output:
     *
-     * p1: 18 p2: 68 => should be close to each other unless we have thread starvation
+     * {@code p1: 18 p2: 68 => should be close to each other unless we have thread starvation}


No reason to include "should be close to each other unless we have thread starvation" in the code block.

You're correct, just did the whole line for cosmetic reasons, but I can surely remove the rest of the statement from it.

akarnokd · 2020-04-01T09:22:44Z

src/test/java/io/reactivex/rxjava3/observers/SerializedObserverTest.java

     *
     * When using SerializedObserver we get:
     *
-     * p1: 1 p2: 2445261 => should be close to each other unless we have thread starvation
+     * {@code p1: 1 p2: 2445261 => should be close to each other unless we have thread starvation}


No reason to include "should be close to each other unless we have thread starvation" in the code block.

akarnokd · 2020-04-01T09:22:52Z

src/test/java/io/reactivex/rxjava3/subscribers/SerializedSubscriberTest.java

@@ -341,11 +341,11 @@ public void onNext(String t) {
     *
     * When using SynchronizedSubscriber we get this output:
     *
-     * p1: 18 p2: 68 => should be close to each other unless we have thread starvation
+     * {@code p1: 18 p2: 68 => should be close to each other unless we have thread starvation}


No reason to include "should be close to each other unless we have thread starvation" in the code block.

akarnokd · 2020-04-01T09:22:57Z

src/test/java/io/reactivex/rxjava3/subscribers/SerializedSubscriberTest.java

     *
     * When using SerializedSubscriber we get:
     *
-     * p1: 1 p2: 2445261 => should be close to each other unless we have thread starvation
+     * {@code p1: 1 p2: 2445261 => should be close to each other unless we have thread starvation}


No reason to include "should be close to each other unless we have thread starvation" in the code block.

akarnokd · 2020-04-01T09:23:37Z

src/test/java/io/reactivex/rxjava3/tck/BaseTck.java

@@ -51,7 +51,7 @@ public long maxElementsFromPublisher() {

    /**
     * Creates an Iterable with the specified number of elements or an infinite one if
-     * elements > {@link Integer#MAX_VALUE}.
+     * {@code elements > {@link Integer#MAX_VALUE}.}


This breaks the link I think.

codecov · 2020-04-01T09:30:38Z

Codecov Report

Merging #6943 into 3.x will decrease coverage by 0.03%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##                3.x    #6943      +/-   ##
============================================
- Coverage     99.63%   99.60%   -0.04%     
+ Complexity     6666     6665       -1     
============================================
  Files           742      742              
  Lines         47220    47228       +8     
  Branches       6367     6369       +2     
============================================
- Hits          47049    47042       -7     
- Misses           54       61       +7     
- Partials        117      125       +8

Impacted Files	Coverage Δ	Complexity Δ
...vex/rxjava3/internal/schedulers/SchedulerWhen.java	`100.00% <ø> (ø)`	`5.00 <0.00> (ø)`
...l/operators/observable/ObservableFlatMapMaybe.java	`89.43% <0.00%> (-5.64%)`	`2.00% <0.00%> (ø%)`
...tivex/rxjava3/internal/jdk8/ParallelCollector.java	`93.57% <0.00%> (-4.59%)`	`2.00% <0.00%> (ø%)`
.../operators/observable/ObservableFlatMapSingle.java	`94.44% <0.00%> (-3.18%)`	`2.00% <0.00%> (ø%)`
...nternal/operators/observable/ObservableCreate.java	`96.58% <0.00%> (-2.57%)`	`2.00% <0.00%> (ø%)`
...ernal/operators/flowable/FlowableFlatMapMaybe.java	`95.85% <0.00%> (-2.08%)`	`2.00% <0.00%> (ø%)`
...tivex/rxjava3/disposables/CompositeDisposable.java	`98.14% <0.00%> (-1.86%)`	`39.00% <0.00%> (-1.00%)`
...ctivex/rxjava3/internal/util/QueueDrainHelper.java	`98.61% <0.00%> (-1.39%)`	`57.00% <0.00%> (-1.00%)`
...3/internal/operators/flowable/FlowablePublish.java	`99.00% <0.00%> (-1.00%)`	`17.00% <0.00%> (-1.00%)`
...ternal/operators/observable/ObservableFlatMap.java	`97.87% <0.00%> (-0.31%)`	`3.00% <0.00%> (ø%)`
... and 8 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 a2128ae...47ef88e. Read the comment docs.

src/main/java/io/reactivex/rxjava3/internal/schedulers/SchedulerWhen.java

src/test/java/io/reactivex/rxjava3/observers/SerializedObserverTest.java

GPopZach

Took all the comments from @akarnokd into account and fixed it up,

GPopZach

Fixed.

docs: Quick Javadoc fixes.

836a0dd

Added @code tag wherever < or > were used, also removed a few self-closing <p> tags. Both of these issues cause errors with the latest version of Javadoc. Signed-off-by: Zachary Trant <zach@graalonline.com>

akarnokd requested changes Apr 1, 2020

View reviewed changes

akarnokd added 3.x Documentation labels Apr 1, 2020

GPopZach added 11 commits April 7, 2020 08:43

Update FuseToFlowable.java

e350d40

Update FuseToMaybe.java

f3c40a0

Update FuseToObservable.java

7d1e662

Update SchedulerWhen.java

ee01a3a

Update BlockingFlowableNextTest.java

7af670f

Update BlockingObservableNextTest.java

c790d98

Update SerializedObserverTest.java

e6e10d0

Update SerializedObserverTest.java

94af8f2

Update SerializedObserverTest.java

559bdc8

Update SerializedSubscriberTest.java

385d91e

Update BaseTck.java

c73dde7

akarnokd reviewed Apr 7, 2020

View reviewed changes

src/main/java/io/reactivex/rxjava3/internal/schedulers/SchedulerWhen.java Outdated Show resolved Hide resolved

src/test/java/io/reactivex/rxjava3/observers/SerializedObserverTest.java Outdated Show resolved Hide resolved

GPopZach commented Apr 7, 2020

View reviewed changes

GPopZach added 2 commits April 7, 2020 09:12

Update SchedulerWhen.java

61fc69f

Update SerializedObserverTest.java

47ef88e

GPopZach commented Apr 7, 2020

View reviewed changes

akarnokd approved these changes Apr 7, 2020

View reviewed changes

akarnokd merged commit 51de021 into ReactiveX:3.x Apr 7, 2020

akarnokd mentioned this pull request Apr 27, 2020

3.0.3 release preparations #6970

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Quick Javadoc fixes. #6943

docs: Quick Javadoc fixes. #6943

GPopZach commented Apr 1, 2020

akarnokd left a comment

akarnokd Apr 1, 2020

akarnokd Apr 1, 2020

akarnokd Apr 1, 2020

akarnokd Apr 1, 2020

akarnokd Apr 1, 2020

akarnokd Apr 1, 2020

GPopZach Apr 7, 2020

akarnokd Apr 1, 2020

akarnokd Apr 1, 2020

akarnokd Apr 1, 2020

akarnokd Apr 1, 2020

codecov bot commented Apr 1, 2020 •

edited

Loading

GPopZach left a comment

GPopZach left a comment

		* {@code Single<Integer> single = Flowable.range(1, 10).reduce((a, b) -> a + b);}
		* {@code Flowable<Integer> flowable = single.toFlowable();}

		* {@code Single<Integer> single = Maybe.just(1).isEmpty();}
		* {@code Maybe<Integer> maybe = single.toMaybe();}

		* {@code Single<Integer> single = Observable.range(1, 10).reduce((a, b) -> a + b);}
		* {@code Observable<Integer> observable = single.toObservable();}

docs: Quick Javadoc fixes. #6943

docs: Quick Javadoc fixes. #6943

Conversation

GPopZach commented Apr 1, 2020

akarnokd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Apr 1, 2020 • edited Loading

Codecov Report

GPopZach left a comment

Choose a reason for hiding this comment

GPopZach left a comment

Choose a reason for hiding this comment

codecov bot commented Apr 1, 2020 •

edited

Loading