2.x - improve timer javadoc (#4694)

Author: davidmoten

src/main/java/io/reactivex/Flowable.java

@@ -3784,7 +3784,7 @@ public static <T> Flowable<T> switchOnNextDelayError(Publisher<? extends Publish
     }
 
     /**
-     * Returns a Flowable that emits one item after a specified delay, and then completes.
+     * Returns a Flowable that emits {@code 0L} after a specified delay, and then completes.
      * <p>
      * <img width="640" height="200" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/timer.png" alt="">
      * <dl>
@@ -3799,7 +3799,7 @@ public static <T> Flowable<T> switchOnNextDelayError(Publisher<? extends Publish
      *            the initial delay before emitting a single {@code 0L}
      * @param unit
      *            time units to use for {@code delay}
-     * @return a Flowable that emits one item after a specified delay, and then completes
+     * @return a Flowable that emits {@code 0L} after a specified delay, and then completes
      * @see <a href="http://reactivex.io/documentation/operators/timer.html">ReactiveX operators documentation: Timer</a>
      */
     @BackpressureSupport(BackpressureKind.ERROR)
@@ -3809,7 +3809,7 @@ public static Flowable<Long> timer(long delay, TimeUnit unit) {
     }
 
     /**
-     * Returns a Flowable that emits one item after a specified delay, on a specified Scheduler, and then
+     * Returns a Flowable that emits {@code 0L} after a specified delay, on a specified Scheduler, and then
      * completes.
      * <p>
      * <img width="640" height="200" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/timer.s.png" alt="">
@@ -3827,7 +3827,7 @@ public static Flowable<Long> timer(long delay, TimeUnit unit) {
      *            time units to use for {@code delay}
      * @param scheduler
      *            the {@link Scheduler} to use for scheduling the item
-     * @return a Flowable that emits one item after a specified delay, on a specified Scheduler, and then
+     * @return a Flowable that emits {@code 0L} after a specified delay, on a specified Scheduler, and then
      *         completes
      * @see <a href="http://reactivex.io/documentation/operators/timer.html">ReactiveX operators documentation: Timer</a>
      */

src/main/java/io/reactivex/Maybe.java

@@ -1264,7 +1264,7 @@ public static <T> Single<Boolean> sequenceEqual(MaybeSource<? extends T> source1
     }
 
     /**
-     * Returns a Maybe that emits one item after a specified delay.
+     * Returns a Maybe that emits {@code 0L} after a specified delay.
      * <p>
      * <img width="640" height="200" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/timer.png" alt="">
      * <dl>
@@ -1276,7 +1276,7 @@ public static <T> Single<Boolean> sequenceEqual(MaybeSource<? extends T> source1
      *            the initial delay before emitting a single {@code 0L}
      * @param unit
      *            time units to use for {@code delay}
-     * @return a Maybe that emits one item after a specified delay
+     * @return a Maybe that emits {@code 0L} after a specified delay
      * @see <a href="http://reactivex.io/documentation/operators/timer.html">ReactiveX operators documentation: Timer</a>
      */
     @SchedulerSupport(SchedulerSupport.COMPUTATION)
@@ -1285,7 +1285,7 @@ public static Maybe<Long> timer(long delay, TimeUnit unit) {
     }
 
     /**
-     * Returns a Maybe that emits one item after a specified delay on a specified Scheduler.
+     * Returns a Maybe that emits {@code 0L} after a specified delay on a specified Scheduler.
      * <p>
      * <img width="640" height="200" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/timer.s.png" alt="">
      * <dl>
@@ -1299,7 +1299,7 @@ public static Maybe<Long> timer(long delay, TimeUnit unit) {
      *            time units to use for {@code delay}
      * @param scheduler
      *            the {@link Scheduler} to use for scheduling the item
-     * @return a Maybe that emits one item after a specified delay, on a specified Scheduler
+     * @return a Maybe that emits {@code 0L} after a specified delay, on a specified Scheduler
      * @see <a href="http://reactivex.io/documentation/operators/timer.html">ReactiveX operators documentation: Timer</a>
      */
     @SchedulerSupport(SchedulerSupport.CUSTOM)

src/main/java/io/reactivex/Observable.java

@@ -3282,7 +3282,7 @@ public static <T> Observable<T> switchOnNextDelayError(ObservableSource<? extend
     }
 
     /**
-     * Returns an Observable that emits one item after a specified delay, and then completes.
+     * Returns an Observable that emits {@code 0L} after a specified delay, and then completes.
      * <p>
      * <img width="640" height="200" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/timer.png" alt="">
      * <dl>
@@ -3294,7 +3294,7 @@ public static <T> Observable<T> switchOnNextDelayError(ObservableSource<? extend
      *            the initial delay before emitting a single {@code 0L}
      * @param unit
      *            time units to use for {@code delay}
-     * @return an Observable that emits one item after a specified delay, and then completes
+     * @return an Observable that {@code 0L} after a specified delay, and then completes
      * @see <a href="http://reactivex.io/documentation/operators/timer.html">ReactiveX operators documentation: Timer</a>
      */
     @SchedulerSupport(SchedulerSupport.COMPUTATION)
@@ -3303,7 +3303,7 @@ public static Observable<Long> timer(long delay, TimeUnit unit) {
     }
 
     /**
-     * Returns an Observable that emits one item after a specified delay, on a specified Scheduler, and then
+     * Returns an Observable that emits {@code 0L} after a specified delay, on a specified Scheduler, and then
      * completes.
      * <p>
      * <img width="640" height="200" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/timer.s.png" alt="">
@@ -3318,7 +3318,7 @@ public static Observable<Long> timer(long delay, TimeUnit unit) {
      *            time units to use for {@code delay}
      * @param scheduler
      *            the {@link Scheduler} to use for scheduling the item
-     * @return an Observable that emits one item after a specified delay, on a specified Scheduler, and then
+     * @return an Observable that emits {@code 0L} after a specified delay, on a specified Scheduler, and then
      *         completes
      * @see <a href="http://reactivex.io/documentation/operators/timer.html">ReactiveX operators documentation: Timer</a>
      */