summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorPaul Phillips <paulp@improving.org>2009-08-22 14:10:22 +0000
committerPaul Phillips <paulp@improving.org>2009-08-22 14:10:22 +0000
commit72a7124873ad8227cc4185b95012f7a83da30a5d (patch)
tree9e07b8e45f0e3fe43613ee3a9ff97a7f95081039 /src
parent0c424e878cf41d4d8f33b4e72339ca8f6f548fbc (diff)
downloadscala-72a7124873ad8227cc4185b95012f7a83da30a5d.tar.gz
scala-72a7124873ad8227cc4185b95012f7a83da30a5d.tar.bz2
scala-72a7124873ad8227cc4185b95012f7a83da30a5d.zip
A few minor documentation fixes.
Diffstat (limited to 'src')
-rw-r--r--src/library/scala/collection/Iterator.scala8
-rw-r--r--src/library/scala/collection/generic/BufferTemplate.scala4
-rw-r--r--src/library/scala/collection/generic/MutableMapTemplate.scala4
-rw-r--r--src/library/scala/collection/generic/MutableSetTemplate.scala4
-rw-r--r--src/library/scala/collection/generic/SequenceTemplate.scala4
5 files changed, 12 insertions, 12 deletions
diff --git a/src/library/scala/collection/Iterator.scala b/src/library/scala/collection/Iterator.scala
index 0a5f48d6ea..beaeacf499 100644
--- a/src/library/scala/collection/Iterator.scala
+++ b/src/library/scala/collection/Iterator.scala
@@ -839,13 +839,13 @@ trait Iterator[+A] { self =>
* defaults to 1. Example usages:
*
* <pre>
- * // returns List(List(1, 2, 3), List(2, 3, 4), List(3, 4, 5))
+ * // Returns List(List(1, 2, 3), List(2, 3, 4), List(3, 4, 5))
* (1 to 5).iterator.sliding(3).toList
- * // returns List(List(1, 2, 3, 4), List(4, 5))
+ * // Returns List(List(1, 2, 3, 4), List(4, 5))
* (1 to 5).iterator.sliding(4, 3).toList
- * // returns List(List(1, 2, 3, 4))
+ * // Returns List(List(1, 2, 3, 4))
* (1 to 5).iterator.sliding(4, 3).withPartial(false).toList
- * // List(List(1, 2, 3, 4), List(4, 5, 30, 35))
+ * // Returns List(List(1, 2, 3, 4), List(4, 5, 20, 25))
* // Illustrating that withPadding's argument is by-name.
* val it2 = Iterator.iterate(20)(_ + 5)
* (1 to 5).iterator.sliding(4, 3).withPadding(it2.next).toList
diff --git a/src/library/scala/collection/generic/BufferTemplate.scala b/src/library/scala/collection/generic/BufferTemplate.scala
index 55f9322949..c7522b465a 100644
--- a/src/library/scala/collection/generic/BufferTemplate.scala
+++ b/src/library/scala/collection/generic/BufferTemplate.scala
@@ -304,10 +304,10 @@ trait BufferTemplate[A, +This <: BufferTemplate[A, This] with Buffer[A]]
thisCollection
}
- /** Removes a number of elements provided by a traversible object and returns
+ /** Removes a number of elements provided by a Traversable object and returns
* the collection itself.
*
- * @param iter the iterable object.
+ * @param iter the Traversable object.
*/
@deprecated("Use --= instead if you intend to remove by side effect from an existing collection.\n"+
"Use `clone() --=` if you intend to create a new collection.")
diff --git a/src/library/scala/collection/generic/MutableMapTemplate.scala b/src/library/scala/collection/generic/MutableMapTemplate.scala
index 5614a885b7..baf5c8b163 100644
--- a/src/library/scala/collection/generic/MutableMapTemplate.scala
+++ b/src/library/scala/collection/generic/MutableMapTemplate.scala
@@ -240,10 +240,10 @@ trait MutableMapTemplate[A, B, +This <: MutableMapTemplate[A, B, This] with muta
thisCollection
}
- /** Removes a number of elements provided by a traversible object and returns
+ /** Removes a number of elements provided by a Traversable object and returns
* the collection itself.
*
- * @param iter the iterable object.
+ * @param iter the Traversable object.
*/
@deprecated("Use --= instead if you intend to remove by side effect from an existing collection.\n"+
"Use `clone() --=' if you intend to create a new collection.")
diff --git a/src/library/scala/collection/generic/MutableSetTemplate.scala b/src/library/scala/collection/generic/MutableSetTemplate.scala
index d79c737e66..c44d06fbd7 100644
--- a/src/library/scala/collection/generic/MutableSetTemplate.scala
+++ b/src/library/scala/collection/generic/MutableSetTemplate.scala
@@ -178,10 +178,10 @@ trait MutableSetTemplate[A, +This <: MutableSetTemplate[A, This] with mutable.Se
thisCollection
}
- /** Removes a number of elements provided by a traversible object and returns
+ /** Removes a number of elements provided by a Traversable object and returns
* the collection itself.
*
- * @param iter the iterable object.
+ * @param iter the Traversable object.
*/
@deprecated("Use --= instead if you intend to remove by side effect from an existing collection.\n"+
"Use `clone() --=' if you intend to create a new collection.")
diff --git a/src/library/scala/collection/generic/SequenceTemplate.scala b/src/library/scala/collection/generic/SequenceTemplate.scala
index 9ae4a29770..eaa00c18d2 100644
--- a/src/library/scala/collection/generic/SequenceTemplate.scala
+++ b/src/library/scala/collection/generic/SequenceTemplate.scala
@@ -618,7 +618,7 @@ trait SequenceTemplate[+A, +This <: IterableTemplate[A, This] with Sequence[A]]
@deprecated("use `drop' instead")
def slice(from: Int): Sequence[A] = slice(from, length)
- @deprecated("Should be replaced by <code>(s1, s2) forall { case (x, y) => f(x, y) }</code>")
+ @deprecated("Should be replaced by <code>(s1, s2) forall { case (x, y) => f(x, y) }</code>")
def equalsWith[B](that: Sequence[B])(f: (A,B) => Boolean): Boolean = {
val i = this.iterator
val j = that.iterator
@@ -630,7 +630,7 @@ trait SequenceTemplate[+A, +This <: IterableTemplate[A, This] with Sequence[A]]
}
/** Is <code>that</code> a slice in this? */
- @deprecated("Should be repaced by <code>indexOfSeq(that) != -1</code>")
+ @deprecated("Should be replaced by <code>indexOfSeq(that) != -1</code>")
def containsSlice[B](that: Sequence[B]): Boolean = indexOfSeq(that) != -1
/**