Skip to content

Commit da987ed

Browse files
committed
javadocs: minor style, grammar changes; add @SInCE annotation to new method
1 parent 1d487a3 commit da987ed

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

src/main/java/rx/subscriptions/Subscriptions.java

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ private Subscriptions() {
3131
throw new IllegalStateException("No instances!");
3232
}
3333
/**
34-
* Returns a {@link Subscription} that <code>unsubscribe</code> does nothing except changing
35-
* <code>isUnsubscribed</code> to true. It's stateful and <code>isUnsubscribed</code>
36-
* indicates if <code>unsubscribe</code> is called, which is different from {@link #unsubscribed()}.
34+
* Returns a {@link Subscription} to which {@code unsubscribe} does nothing except to change
35+
* {@code isUnsubscribed} to {@code true}. It's stateful and {@code isUnsubscribed} indicates if
36+
* {@code unsubscribe} is called, which is different from {@link #unsubscribed()}.
3737
*
3838
* <pre><code>
3939
* Subscription empty = Subscriptions.empty();
@@ -42,23 +42,24 @@ private Subscriptions() {
4242
* System.out.println(empty.isUnsubscribed()); // true
4343
* </code></pre>
4444
*
45-
* @return a {@link Subscription} that <code>unsubscribe</code> does nothing except changing
46-
* <code>isUnsubscribed</code> to true.
45+
* @return a {@link Subscription} to which {@code unsubscribe} does nothing except to change
46+
* {@code isUnsubscribed} to {@code true}
4747
*/
4848
public static Subscription empty() {
4949
return BooleanSubscription.create();
5050
}
5151

5252
/**
53-
* Returns a {@link Subscription} that <code>unsubscribe</code> does nothing but is already unsubscribed.
54-
* Its <code>isUnsubscribed</code> always return true, which is different from {@link #empty()}.
53+
* Returns a {@link Subscription} to which {@code unsubscribe} does nothing, as it is already unsubscribed.
54+
* Its {@code isUnsubscribed} always returns {@code true}, which is different from {@link #empty()}.
5555
*
5656
* <pre><code>
5757
* Subscription unsubscribed = Subscriptions.unsubscribed();
5858
* System.out.println(unsubscribed.isUnsubscribed()); // true
5959
* </code></pre>
6060
*
61-
* @return a {@link Subscription} that <code>unsubscribe</code> does nothing but is already unsubscribed.
61+
* @return a {@link Subscription} to which {@code unsubscribe} does nothing, as it is already unsubscribed
62+
* @since (if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number)
6263
*/
6364
@Experimental
6465
public static Subscription unsubscribed() {

0 commit comments

Comments
 (0)