Skip to content

Commit d8a3a8f

Browse files
author
jmhofer
committed
Added some api documentation.
1 parent 87b53fa commit d8a3a8f

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

extensions/rxjava-swing/src/main/java/rx/SwingObservable.java

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,18 @@
2121

2222
import rx.swing.sources.AbstractButtonSource;
2323

24+
/**
25+
* Allows creating observables from various sources specific to Swing.
26+
*/
2427
public enum SwingObservable { ; // no instances
2528

29+
/**
30+
* Creates an observable corresponding to a Swing button action.
31+
*
32+
* @param button
33+
* The button to register the observable for.
34+
* @return Observable of action events.
35+
*/
2636
public static Observable<ActionEvent> fromButtonAction(AbstractButton button) {
2737
return AbstractButtonSource.fromActionOf(button);
2838
}

0 commit comments

Comments
 (0)