Javadoc Cleanup

benjchristensen · benjchristensen · commit e44bd8c309e3 · 2013-08-30T10:44:20.000-07:00
diff --git a/rxjava-core/src/main/java/rx/Observable.java b/rxjava-core/src/main/java/rx/Observable.java
@@ -781,13 +781,11 @@ public static <T> Observable<T> switchDo(Observable<Observable<T>> sequenceOfSeq
     }
 
     /**
-     * Given an Observable that emits Observables, creates a single Observable that
+     * On an Observable that emits Observables, creates a single Observable that
      * emits the items emitted by the most recently published of those Observables.
      * <p>
      * <img width="640" src="https://github.com/Netflix/RxJava/wiki/images/rx-operators/switchDo.png">
      * 
-     * @param sequenceOfSequences
-     *            the source Observable that emits Observables
      * @return an Observable that emits only the items emitted by the most recently published
      *         Observable
      * @throws ClassCastException
@@ -1133,7 +1131,7 @@ public Observable<List<T>> buffer(int count) {
      *            The maximum size of each buffer before it should be emitted.
      * @param skip
      *            How many produced values need to be skipped before starting a new buffer. Note that when "skip" and
-     *            "count" are equals that this is the same operation as {@link Observable#buffer(Observable, int)}.
+     *            "count" are equals that this is the same operation as {@link Observable#buffer(int)}.
      * @return
      *         An {@link Observable} which produces buffers every "skipped" values containing at most
      *         "count" produced values.
diff --git a/rxjava-core/src/main/java/rx/Subscription.java b/rxjava-core/src/main/java/rx/Subscription.java
@@ -20,7 +20,7 @@
 /**
  * Subscription returns from {@link Observable#subscribe(Observer)} to allow unsubscribing.
  * <p>
- * See utilities in {@link Subscriptions} and implementations in the {@link rx.subscriptions} package.
+ * See utilities in {@link Subscriptions} and implementations in the {@code rx.subscriptions} package.
  * <p>
  * This interface is the RxJava equivalent of {@code IDisposable} in Microsoft's Rx implementation.
  */
diff --git a/rxjava-core/src/main/java/rx/observables/GroupedObservable.java b/rxjava-core/src/main/java/rx/observables/GroupedObservable.java
@@ -24,7 +24,7 @@
  * An {@link Observable} that has been grouped by a key whose value can be obtained using
  * {@link #getKey()} <p>
  *
- * @see Observable#groupBy(Observable, Func1)
+ * @see Observable#groupBy(Func1)
  *
  * @param <K> the type of the key
  * @param <T> the type of the elements in the group
diff --git a/rxjava-core/src/main/java/rx/operators/OperationToIterator.java b/rxjava-core/src/main/java/rx/operators/OperationToIterator.java
@@ -43,8 +43,6 @@ public class OperationToIterator {
     /**
      * Returns an iterator that iterates all values of the observable.
      * 
-     * @param that
-     *            an observable sequence to get an iterator for.
      * @param <T>
      *            the type of source.
      * @return the iterator that could be used to iterate over the elements of the observable.

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`* An {@link Observable} that has been grouped by a key whose value can be obtained using`
`25`	`25`	`* {@link #getKey()} <p>`
`26`	`26`	`*`
`27`		`- * @see Observable#groupBy(Observable, Func1)`
	`27`	`+ * @see Observable#groupBy(Func1)`
`28`	`28`	`*`
`29`	`29`	`* @param <K> the type of the key`
`30`	`30`	`* @param <T> the type of the elements in the group`
Original file line number	Diff line number	Diff line change
`@@ -43,8 +43,6 @@ public class OperationToIterator {`
`43`	`43`	`/**`
`44`	`44`	`* Returns an iterator that iterates all values of the observable.`
`45`	`45`	`*`
`46`		`- * @param that`
`47`		`- * an observable sequence to get an iterator for.`
`48`	`46`	`* @param <T>`
`49`	`47`	`* the type of source.`
`50`	`48`	`* @return the iterator that could be used to iterate over the elements of the observable.`