Skip to content

Commit 7108d09

Browse files
author
jmhofer
committed
Fixed links in the javadocs, mostly.
1 parent b9466bb commit 7108d09

11 files changed

+39
-26
lines changed

rxjava-core/src/main/java/rx/Observable.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -873,7 +873,7 @@ public static <T> Observable<T> where(Observable<T> that, Func1<T, Boolean> pred
873873
* @param <T>
874874
* the type of items in the {@link Iterable} sequence and the type emitted by the resulting Observable
875875
* @return an Observable that emits each item in the source {@link Iterable} sequence
876-
* @see {@link #toObservable(Iterable)}
876+
* @see #toObservable(Iterable)
877877
*/
878878
public static <T> Observable<T> from(Iterable<T> iterable) {
879879
return toObservable(iterable);
@@ -887,7 +887,7 @@ public static <T> Observable<T> from(Iterable<T> iterable) {
887887
* @param <T>
888888
* the type of items in the Array, and the type of items emitted by the resulting Observable
889889
* @return an Observable that emits each item in the source Array
890-
* @see {@link #toObservable(Object...)}
890+
* @see #toObservable(Object...)
891891
*/
892892
public static <T> Observable<T> from(T... items) {
893893
return toObservable(items);
@@ -1191,7 +1191,7 @@ public R call(T t1) {
11911191
* @return an Observable that emits a sequence that is the result of applying the transformation
11921192
* function to each item emitted by the source Observable and merging the results of
11931193
* the Observables obtained from this transformation
1194-
* @see {@link #flatMap(Observable, Func1)}
1194+
* @see #flatMap(Observable, Func1)
11951195
*/
11961196
public static <T, R> Observable<R> mapMany(Observable<T> sequence, Func1<T, Observable<R>> func) {
11971197
return create(OperationMap.mapMany(sequence, func));
@@ -1379,7 +1379,7 @@ public static <T> Observable<T> finallyDo(Observable<T> source, Action0 action)
13791379
* @return an Observable that emits a sequence that is the result of applying the transformation
13801380
* function to each item emitted by the source Observable and merging the results of
13811381
* the Observables obtained from this transformation
1382-
* @see {@link #mapMany(Observable, Func1)}
1382+
* @see #mapMany(Observable, Func1)
13831383
*/
13841384
public static <T, R> Observable<R> flatMap(Observable<T> sequence, Func1<T, Observable<R>> func) {
13851385
return mapMany(sequence, func);
@@ -1407,7 +1407,7 @@ public static <T, R> Observable<R> flatMap(Observable<T> sequence, Func1<T, Obse
14071407
* @return an Observable that emits a sequence that is the result of applying the transformation
14081408
* function to each item emitted by the source Observable and merging the results of
14091409
* the Observables obtained from this transformation
1410-
* @see {@link #mapMany(Observable, Func1)}
1410+
* @see #mapMany(Observable, Func1)
14111411
*/
14121412
public static <T, R> Observable<R> flatMap(Observable<T> sequence, final Object func) {
14131413
return mapMany(sequence, func);
@@ -2074,7 +2074,7 @@ public Boolean call(T t, Integer integer)
20742074
*
20752075
* @param that
20762076
* the source Observable
2077-
* @returna Future that expects a single item emitted by the source Observable
2077+
* @return a Future that expects a single item emitted by the source Observable
20782078
*/
20792079
public static <T> Future<T> toFuture(final Observable<T> that) {
20802080
return OperationToFuture.toFuture(that);
@@ -2764,7 +2764,7 @@ public Boolean call(T t1) {
27642764
* @return an Observable that emits a sequence that is the result of applying the transformation
27652765
* function to each item in the input sequence and merging the results of the
27662766
* Observables obtained from this transformation.
2767-
* @see {@link #mapMany(Func1)}
2767+
* @see #mapMany(Func1)
27682768
*/
27692769
public <R> Observable<R> flatMap(Func1<T, Observable<R>> func) {
27702770
return mapMany(func);
@@ -2785,7 +2785,7 @@ public <R> Observable<R> flatMap(Func1<T, Observable<R>> func) {
27852785
* @return an Observable that emits a sequence that is the result of applying the transformation'
27862786
* function to each item in the input sequence and merging the results of the
27872787
* Observables obtained from this transformation.
2788-
* @see {@link #mapMany(Object)}
2788+
* @see #mapMany(Object)
27892789
*/
27902790
public <R> Observable<R> flatMap(final Object callback) {
27912791
return mapMany(callback);
@@ -2935,7 +2935,7 @@ public R call(T t1) {
29352935
* @return an Observable that emits a sequence that is the result of applying the transformation
29362936
* function to each item in the input sequence and merging the results of the
29372937
* Observables obtained from this transformation.
2938-
* @see {@link #flatMap(Func1)}
2938+
* @see #flatMap(Func1)
29392939
*/
29402940
public <R> Observable<R> mapMany(Func1<T, Observable<R>> func) {
29412941
return mapMany(this, func);
@@ -2956,7 +2956,7 @@ public <R> Observable<R> mapMany(Func1<T, Observable<R>> func) {
29562956
* @return an Observable that emits a sequence that is the result of applying the transformation'
29572957
* function to each item in the input sequence and merging the results of the
29582958
* Observables obtained from this transformation.
2959-
* @see {@link #flatMap(Object))}
2959+
* @see #flatMap(Object)
29602960
*/
29612961
public <R> Observable<R> mapMany(final Object callback) {
29622962
@SuppressWarnings("rawtypes")
@@ -3492,7 +3492,7 @@ public <E> Observable<T> takeUntil(Observable<E> other) {
34923492
* <p>
34933493
* This will throw an exception if the Observable emits more than 1 value. If more than 1 are expected then use <code>toList().toFuture()</code>.
34943494
*
3495-
* @returna Future that expects a single item emitted by the source Observable
3495+
* @return a Future that expects a single item emitted by the source Observable
34963496
*/
34973497
public Future<T> toFuture() {
34983498
return toFuture(this);

rxjava-core/src/main/java/rx/observables/GroupedObservable.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
/**
2424
* An {@link Observable} that has been grouped by a key whose value can be obtained using {@link #getKey()} <p>
2525
*
26-
* @see {@link Observable#groupBy(Observable, Func1)}
26+
* @see Observable#groupBy(Observable, Func1)
2727
*
2828
* @param <K>
2929
* @param <T>

rxjava-core/src/main/java/rx/operators/OperationDematerialize.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
/**
3030
* Dematerializes the explicit notification values of an observable sequence as implicit notifications.
31-
* See http://msdn.microsoft.com/en-us/library/hh229047(v=vs.103).aspx for the Microsoft Rx equivalent.
31+
* See <a href="http://msdn.microsoft.com/en-us/library/hh229047(v=vs.103).aspx">here</a> for the Microsoft Rx equivalent.
3232
*/
3333
public final class OperationDematerialize {
3434

@@ -38,7 +38,7 @@ public final class OperationDematerialize {
3838
* @param sequence
3939
* An observable sequence containing explicit notification values which have to be turned into implicit notifications.
4040
* @return An observable sequence exhibiting the behavior corresponding to the source sequence's notification values.
41-
* @see http://msdn.microsoft.com/en-us/library/hh229047(v=vs.103).aspx
41+
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229047(v=vs.103).aspx">Observable.Dematerialize(TSource) Method </a>
4242
*/
4343
public static <T> Func1<Observer<T>, Subscription> dematerialize(final Observable<Notification<T>> sequence) {
4444
return new DematerializeObservable<T>(sequence);

rxjava-core/src/main/java/rx/operators/OperationMaterialize.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
* <p>
3434
* In other words, converts a sequence of OnNext, OnError and OnCompleted events into a sequence of ObservableNotifications containing the OnNext, OnError and OnCompleted values.
3535
* <p>
36-
* See http://msdn.microsoft.com/en-us/library/hh229453(v=VS.103).aspx for the Microsoft Rx equivalent.
36+
* See <a href="http://msdn.microsoft.com/en-us/library/hh229453(v=VS.103).aspx">here</a> for the Microsoft Rx equivalent.
3737
*/
3838
public final class OperationMaterialize {
3939

@@ -43,7 +43,7 @@ public final class OperationMaterialize {
4343
* @param source
4444
* An observable sequence of elements to project.
4545
* @return An observable sequence whose elements are the result of materializing the notifications of the given sequence.
46-
* @see http://msdn.microsoft.com/en-us/library/hh229453(v=VS.103).aspx
46+
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229453(v=VS.103).aspx">Observable.Materialize(TSource) Method </a>
4747
*/
4848
public static <T> Func1<Observer<Notification<T>>, Subscription> materialize(final Observable<T> sequence) {
4949
return new MaterializeObservable<T>(sequence);

rxjava-core/src/main/java/rx/operators/OperationMerge.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public final class OperationMerge {
4747
* @param source
4848
* An observable sequence of elements to project.
4949
* @return An observable sequence whose elements are the result of flattening the output from the list of Observables.
50-
* @see http://msdn.microsoft.com/en-us/library/hh229099(v=vs.103).aspx
50+
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229099(v=vs.103).aspx">Observable.Merge(TSource) Method (IObservable(TSource)[])</a>
5151
*/
5252
public static <T> Func1<Observer<T>, Subscription> merge(final Observable<Observable<T>> o) {
5353
// wrap in a Func so that if a chain is built up, then asynchronously subscribed to twice we will have 2 instances of Take<T> rather than 1 handing both, which is not thread-safe.

rxjava-core/src/main/java/rx/operators/OperationMergeDelayError.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public final class OperationMergeDelayError {
5454
* @param source
5555
* An observable sequence of elements to project.
5656
* @return An observable sequence whose elements are the result of flattening the output from the list of Observables.
57-
* @see http://msdn.microsoft.com/en-us/library/hh229099(v=vs.103).aspx
57+
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229099(v=vs.103).aspx">Observable.Merge(TSource) Method (IObservable(TSource)[])</a>
5858
*/
5959
public static <T> Func1<Observer<T>, Subscription> mergeDelayError(final Observable<Observable<T>> sequences) {
6060
// wrap in a Func so that if a chain is built up, then asynchronously subscribed to twice we will have 2 instances of Take<T> rather than 1 handing both, which is not thread-safe.

rxjava-core/src/main/java/rx/operators/OperationScan.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public final class OperationScan {
4141
* An accumulator function to be invoked on each element from the sequence.
4242
*
4343
* @return An observable sequence whose elements are the result of accumulating the output from the list of Observables.
44-
* @see http://msdn.microsoft.com/en-us/library/hh211665(v=vs.103).aspx
44+
* @see <a href="http://msdn.microsoft.com/en-us/library/hh212007%28v=vs.103%29.aspx">Observable.Scan(TSource, TAccumulate) Method (IObservable(TSource), TAccumulate, Func(TAccumulate, TSource, TAccumulate))</a>
4545
*/
4646
public static <T> Func1<Observer<T>, Subscription> scan(Observable<T> sequence, T initialValue, Func2<T, T, T> accumulator) {
4747
return new Accumulator<T>(sequence, initialValue, accumulator);
@@ -56,7 +56,7 @@ public static <T> Func1<Observer<T>, Subscription> scan(Observable<T> sequence,
5656
* An accumulator function to be invoked on each element from the sequence.
5757
*
5858
* @return An observable sequence whose elements are the result of accumulating the output from the list of Observables.
59-
* @see http://msdn.microsoft.com/en-us/library/hh211665(v=vs.103).aspx
59+
* @see <a href="http://msdn.microsoft.com/en-us/library/hh211665(v=vs.103).aspx">Observable.Scan(TSource) Method (IObservable(TSource), Func(TSource, TSource, TSource))</a>
6060
*/
6161
public static <T> Func1<Observer<T>, Subscription> scan(Observable<T> sequence, Func2<T, T, T> accumulator) {
6262
return new Accumulator<T>(sequence, null, accumulator);

rxjava-core/src/main/java/rx/operators/OperationSkip.java

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,6 @@
2929

3030
/**
3131
* Skips a specified number of contiguous values from the start of a Observable sequence and then returns the remaining values.
32-
*
33-
* @param <T>
3432
*/
3533
public final class OperationSkip {
3634

@@ -41,7 +39,7 @@ public final class OperationSkip {
4139
* @param num
4240
* @return
4341
*
44-
* @see http://msdn.microsoft.com/en-us/library/hh229847(v=vs.103).aspx
42+
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229847(v=vs.103).aspx">Observable.Skip(TSource) Method</a>
4543
*/
4644
public static <T> Func1<Observer<T>, Subscription> skip(final Observable<T> items, final int num) {
4745
// wrap in a Observable so that if a chain is built up, then asynchronously subscribed to twice we will have 2 instances of Take<T> rather than 1 handing both, which is not thread-safe.

rxjava-core/src/main/java/rx/operators/OperationToIterator.java

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
/**
2+
* Copyright 2013 Netflix, Inc.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
116
package rx.operators;
217

318
import static org.junit.Assert.*;
@@ -17,7 +32,7 @@
1732
import rx.util.functions.Func1;
1833

1934
/**
20-
* @see https://github.com/Netflix/RxJava/issues/50
35+
* @see <a href="https://github.com/Netflix/RxJava/issues/50">Issue #50</a>
2136
*/
2237
public class OperationToIterator {
2338

rxjava-core/src/main/java/rx/subscriptions/BooleanSubscription.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
/**
2424
* Subscription that can be checked for status such as in a loop inside an {@link Observable} to exit the loop if unsubscribed.
2525
*
26-
* @see Rx.Net equivalent BooleanDisposable at http://msdn.microsoft.com/en-us/library/system.reactive.disposables.booleandisposable(v=vs.103).aspx
26+
* @see <a href="http://msdn.microsoft.com/en-us/library/system.reactive.disposables.booleandisposable(v=vs.103).aspx">Rx.Net equivalent BooleanDisposable</a>
2727
*/
2828
public class BooleanSubscription implements Subscription {
2929

0 commit comments

Comments
 (0)