From 3c8bc3ab731206f93ad8428b11276237d1397a08 Mon Sep 17 00:00:00 2001 From: Aleksandar Pokopec Date: Fri, 15 Apr 2011 07:54:54 +0000 Subject: Couple of fixes to the usecases in docs. No review. --- src/library/scala/collection/GenIterableLike.scala | 4 ++-- src/library/scala/collection/GenSeqLike.scala | 8 ++++---- src/library/scala/collection/GenTraversableLike.scala | 10 +++++----- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/library/scala/collection/GenIterableLike.scala b/src/library/scala/collection/GenIterableLike.scala index 94713228bf..d7b4b2ee5e 100644 --- a/src/library/scala/collection/GenIterableLike.scala +++ b/src/library/scala/collection/GenIterableLike.scala @@ -47,7 +47,7 @@ private[collection] trait GenIterableLike[+A, +Repr] extends GenTraversableLike[ * @tparam B the type of the elements of collection `that`. * @return `true`, if both collections contain the same elements in the same order, `false` otherwise. * - * @usecase def sameElements(that: Iterable[A]): Boolean + * @usecase def sameElements(that: GenIterable[A]): Boolean * * @param that the collection to compare with. * @return `true`, if both collections contain the same elements in the same order, `false` otherwise. @@ -70,7 +70,7 @@ private[collection] trait GenIterableLike[+A, +Repr] extends GenTraversableLike[ * corresponding elements of this $coll and `that`. The length * of the returned collection is the minimum of the lengths of this $coll and `that`. * - * @usecase def zip[B](that: Iterable[B]): $Coll[(A, B)] + * @usecase def zip[B](that: GenIterable[B]): $Coll[(A, B)] * * @param that The iterable providing the second half of each result pair * @tparam B the type of the second half of the returned pairs diff --git a/src/library/scala/collection/GenSeqLike.scala b/src/library/scala/collection/GenSeqLike.scala index 61902bea37..1502853d8e 100644 --- a/src/library/scala/collection/GenSeqLike.scala +++ b/src/library/scala/collection/GenSeqLike.scala @@ -240,7 +240,7 @@ private[collection] trait GenSeqLike[+A, +Repr] extends GenIterableLike[A, Repr] * @return a new $coll consisting of all elements of this $coll * except that `replaced` elements starting from `from` are replaced * by `patch`. - * @usecase def patch(from: Int, that: Seq[A], replaced: Int): $Coll[A] + * @usecase def patch(from: Int, that: GenSeq[A], replaced: Int): $Coll[A] * @return a new $coll consisting of all elements of this $coll * except that `replaced` elements starting from `from` are replaced * by `patch`. @@ -332,7 +332,7 @@ private[collection] trait GenSeqLike[+A, +Repr] extends GenIterableLike[A, Repr] * @param bf $bfinfo * @return a new collection of type `That` which contains all elements of this $coll * followed by all elements of `that`. - * @usecase def union(that: Seq[A]): $Coll[A] + * @usecase def union(that: GenSeq[A]): $Coll[A] * @return a new $coll which contains all elements of this $coll * followed by all elements of `that`. */ @@ -350,7 +350,7 @@ private[collection] trait GenSeqLike[+A, +Repr] extends GenIterableLike[A, Repr] * If an element value `x` appears * ''n'' times in `that`, then the first ''n'' occurrences of `x` will not form * part of the result, but any following occurrences will. - * @usecase def diff(that: Seq[A]): $Coll[A] + * @usecase def diff(that: GenSeq[A]): $Coll[A] * @return a new $coll which contains all elements of this $coll * except some of occurrences of elements that also appear in `that`. * If an element value `x` appears @@ -371,7 +371,7 @@ private[collection] trait GenSeqLike[+A, +Repr] extends GenIterableLike[A, Repr] * If an element value `x` appears * ''n'' times in `that`, then the first ''n'' occurrences of `x` will be retained * in the result, but any following occurrences will be omitted. - * @usecase def intersect(that: Seq[A]): $Coll[A] + * @usecase def intersect(that: GenSeq[A]): $Coll[A] * @return a new $coll which contains all elements of this $coll * which also appear in `that`. * If an element value `x` appears diff --git a/src/library/scala/collection/GenTraversableLike.scala b/src/library/scala/collection/GenTraversableLike.scala index 558e528808..e415e47ce8 100644 --- a/src/library/scala/collection/GenTraversableLike.scala +++ b/src/library/scala/collection/GenTraversableLike.scala @@ -38,6 +38,9 @@ import annotation.migration * * Note: will not terminate for infinite-sized collections. * + * @define traversableInfo + * This is a base trait of all kinds of Scala collections. + * * @define Coll GenTraversable * @define coll general collection * @tparam A the collection element type. @@ -80,9 +83,6 @@ private[collection] trait GenTraversableLike[+A, +Repr] extends GenTraversableOn * @param z neutral element for the operator `op` * @param op the associative operator for the scan * @param cbf combiner factory which provides a combiner - * @return a collection containing the prefix scan of the elements in the original collection - * - * @usecase def scan(z: B)(op: (B, B) => B): $Coll[B] * * @return a new $coll containing the prefix scan of the elements in this $coll */ @@ -184,7 +184,7 @@ private[collection] trait GenTraversableLike[+A, +Repr] extends GenTraversableOn * @return a new collection of type `That` resulting from applying the given collection-valued function * `f` to each element of this $coll and concatenating the results. * - * @usecase def flatMap[B](f: A => TraversableOnce[B]): $Coll[B] + * @usecase def flatMap[B](f: A => GenTraversableOnce[B]): $Coll[B] * * @return a new $coll resulting from applying the given collection-valued function * `f` to each element of this $coll and concatenating the results. @@ -200,7 +200,7 @@ private[collection] trait GenTraversableLike[+A, +Repr] extends GenTraversableOn * @return a new collection of type `That` which contains all elements * of this $coll followed by all elements of `that`. * - * @usecase def ++[B](that: TraversableOnce[B]): $Coll[B] + * @usecase def ++[B](that: GenTraversableOnce[B]): $Coll[B] * * @return a new $coll which contains all elements of this $coll * followed by all elements of `that`. -- cgit v1.2.3