Skip to content

Commit 00e58f4

Browse files
committed
javadocs: adding @SInCE annotation; adjusting failed @link targets to @code
1 parent 020e843 commit 00e58f4

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

src/main/java/rx/plugins/RxJavaErrorHandler.java

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
* For example, all {@code Exception}s can be logged using this handler even if
2929
* {@link Subscriber#onError(Throwable)} is ignored or not provided when an {@link Observable} is subscribed to.
3030
* <p>
31-
* This plugin is also responsible for augmenting rendering of {@link OnErrorThrowable.OnNextValue}.
31+
* This plugin is also responsible for augmenting rendering of {@code OnErrorThrowable.OnNextValue}.
3232
* <p>
3333
* See {@link RxJavaPlugins} or the RxJava GitHub Uncyclo for information on configuring plugins: <a
3434
* href="https://github.com/ReactiveX/RxJava/wiki/Plugins">https://github.com/ReactiveX/RxJava/wiki/Plugins</a>.
@@ -52,17 +52,21 @@ public void handleError(Throwable e) {
5252
protected static final String ERROR_IN_RENDERING_SUFFIX = ".errorRendering";
5353

5454
/**
55-
* Receives items causing {@link OnErrorThrowable.OnNextValue} and gives a chance to choose the String
56-
* representation of the item in the OnNextValue stacktrace rendering. Returns null if this type of item
57-
* is not managed and should use default rendering.
55+
* Receives items causing {@code OnErrorThrowable.OnNextValue} and gives a chance to choose the String
56+
* representation of the item in the {@code OnNextValue} stacktrace rendering. Returns {@code null} if this
57+
* type of item is not managed and should use default rendering.
5858
* <p>
59-
* Note that primitive types are always rendered as their toString() value.
59+
* Note that primitive types are always rendered as their {@code toString()} value.
6060
* <p>
6161
* If a {@code Throwable} is caught when rendering, this will fallback to the item's classname suffixed by
6262
* {@value #ERROR_IN_RENDERING_SUFFIX}.
6363
*
64-
* @param item the last emitted item, that caused the exception wrapped in {@link OnErrorThrowable.OnNextValue}.
65-
* @return a short {@link String} representation of the item if one is known for its type, or null for default.
64+
* @param item the last emitted item, that caused the exception wrapped in
65+
* {@code OnErrorThrowable.OnNextValue}
66+
* @return a short {@link String} representation of the item if one is known for its type, or null for
67+
* default
68+
* @since (if this graduates from Experimental/Beta to supported, replace this parenthetical with the
69+
* release number)
6670
*/
6771
@Experimental
6872
public final String handleOnNextValueRendering(Object item) {
@@ -80,16 +84,20 @@ public final String handleOnNextValueRendering(Object item) {
8084
/**
8185
* Override this method to provide rendering for specific types other than primitive types and null.
8286
* <p>
83-
* For performance and overhead reasons, this should should limit to a safe production of a short {@code String}
84-
* (as large renderings will bloat up the stacktrace). Prefer to try/catch({@code Throwable}) all code
85-
* inside this method implementation.
87+
* For performance and overhead reasons, this should should limit to a safe production of a short
88+
* {@code String} (as large renderings will bloat up the stacktrace). Prefer to try/catch({@code Throwable})
89+
* all code inside this method implementation.
8690
* <p>
8791
* If a {@code Throwable} is caught when rendering, this will fallback to the item's classname suffixed by
8892
* {@value #ERROR_IN_RENDERING_SUFFIX}.
8993
*
90-
* @param item the last emitted item, that caused the exception wrapped in {@link OnErrorThrowable.OnNextValue}.
91-
* @return a short {@link String} representation of the item if one is known for its type, or null for default.
94+
* @param item the last emitted item, that caused the exception wrapped in
95+
* {@code OnErrorThrowable.OnNextValue}
96+
* @return a short {@link String} representation of the item if one is known for its type, or null for
97+
* default
9298
* @throws InterruptedException if the rendering thread is interrupted
99+
* @since (if this graduates from Experimental/Beta to supported, replace this parenthetical with the
100+
* release number)
93101
*/
94102
@Experimental
95103
protected String render (Object item) throws InterruptedException {

0 commit comments

Comments
 (0)