Skip to content

Commit 192f444

Browse files
committed
Make the javadoc descriptions of various Exception implementations parallel one another better (#1841)
1 parent 2f1f32e commit 192f444

File tree

5 files changed

+8
-6
lines changed

5 files changed

+8
-6
lines changed

src/main/java/rx/exceptions/CompositeException.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
import java.util.Set;
2727

2828
/**
29-
* An Exception that is a composite of one or more other Exceptions. A {@code CompositeException} does not
30-
* modify the structure of any exception it wraps, but at print-time it iterates through the list of
29+
* Represents an exception that is a composite of one or more other exceptions. A {@code CompositeException}
30+
* does not modify the structure of any exception it wraps, but at print-time it iterates through the list of
3131
* Throwables contained in the composit in order to print them all.
3232
*
3333
* Its invariant is to contain an immutable, ordered (by insertion order), unique list of non-composite

src/main/java/rx/exceptions/Exceptions.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ private Exceptions() {
2828

2929
/**
3030
* @warn javadoc missing
31-
* @return
31+
* @return because {@code propagate} itself throws an exception or error, this is a sort of phantom return
32+
* value; {@code propagate} does not actually return anything
3233
*/
3334
public static RuntimeException propagate(Throwable t) {
3435
/*

src/main/java/rx/exceptions/MissingBackpressureException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
package rx.exceptions;
1717

1818
/**
19-
* {@code MissingBackpressureException} indicates that a Subscriber or operator attempted to apply reactive pull
19+
* Represents an exception that indicates that a Subscriber or operator attempted to apply reactive pull
2020
* backpressure to an Observable that does not implement it.
2121
* <p>
2222
* If an Observable has not been written to support reactive pull backpressure (such support is not a

src/main/java/rx/exceptions/OnErrorFailedException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
import rx.Subscriber;
1919

2020
/**
21-
* Used to re-throw errors thrown from {@link Subscriber#onError(Throwable)}.
21+
* Represents an exception used to re-throw errors thrown from {@link Subscriber#onError(Throwable)}.
2222
* <p>
2323
* @see <a href="https://github.com/ReactiveX/RxJava/issues/969">RxJava issue #969</a>
2424
*/

src/main/java/rx/exceptions/OnErrorNotImplementedException.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
import rx.Subscriber;
1919

2020
/**
21-
* Used to re-throw {@link Subscriber#onError(Throwable)} when an implementation doesn't exist.
21+
* Represents an exception used to re-throw {@link Subscriber#onError(Throwable)} when an implementation doesn't
22+
* exist.
2223
* <p>
2324
* Rx Design Guidelines 5.2:
2425
* <blockquote><p>

0 commit comments

Comments
 (0)