Skip to content

Commit

Permalink
Update Javadoc comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
TomasMikula committed Jun 3, 2014
1 parent 7753d84 commit ade3b67
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions reactfx/src/main/java/org/reactfx/EventStreams.java
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@ protected Subscription subscribeToInputs() {
/**
* Returns an event stream that emits periodic <i>ticks</i>. The returned
* stream may only be used on the JavaFX application thread.
*
* <p>As with all lazily bound streams, ticks are emitted only when there
* is at least one subscriber to the returned stream. This means that to
* release associated resources, it suffices to unsubscribe from the
* returned stream.
*/
public static EventStream<?> ticks(Duration interval) {
return new LazilyBoundStream<Void>() {
Expand All @@ -159,6 +164,12 @@ protected Subscription subscribeToInputs() {
* Returns an event stream that emits periodic <i>ticks</i> on the given
* {@code eventThreadExecutor}. The returned stream may only be used from
* that executor's thread.
*
* <p>As with all lazily bound streams, ticks are emitted only when there
* is at least one subscriber to the returned stream. This means that to
* release associated resources, it suffices to unsubscribe from the
* returned stream.
*
* @param scheduler scheduler used to schedule periodic emissions.
* @param eventThreadExecutor single-thread executor used to emit the ticks.
*/
Expand Down

0 comments on commit ade3b67

Please sign in to comment.