Skip to content

Commit 09695b4

Browse files
authored
2.x: Inline CompositeDisposable JavaDoc (#6031)
1 parent 6038c02 commit 09695b4

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

src/main/java/io/reactivex/disposables/CompositeDisposable.java

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,12 @@ public boolean isDisposed() {
8585
return disposed;
8686
}
8787

88+
/**
89+
* Adds a disposable to this container or disposes it if the
90+
* container has been disposed.
91+
* @param d the disposable to add, not null
92+
* @return true if successful, false if this container has been disposed
93+
*/
8894
@Override
8995
public boolean add(@NonNull Disposable d) {
9096
ObjectHelper.requireNonNull(d, "d is null");
@@ -135,6 +141,12 @@ public boolean addAll(@NonNull Disposable... ds) {
135141
return false;
136142
}
137143

144+
/**
145+
* Removes and disposes the given disposable if it is part of this
146+
* container.
147+
* @param d the disposable to remove and dispose, not null
148+
* @return true if the operation was successful
149+
*/
138150
@Override
139151
public boolean remove(@NonNull Disposable d) {
140152
if (delete(d)) {
@@ -144,6 +156,12 @@ public boolean remove(@NonNull Disposable d) {
144156
return false;
145157
}
146158

159+
/**
160+
* Removes (but does not dispose) the given disposable if it is part of this
161+
* container.
162+
* @param d the disposable to remove, not null
163+
* @return true if the operation was successful
164+
*/
147165
@Override
148166
public boolean delete(@NonNull Disposable d) {
149167
ObjectHelper.requireNonNull(d, "Disposable item is null");

0 commit comments

Comments
 (0)