Skip to content
Permalink
Browse files

Fixes SI-4478.

- Replaced/simplified usages of "wrt".
- Added backticks to $Coll definitions, so stuff like "immutable.Stack"
  hopefully stops being interpreted as the end of a sentence and shown
  like that in the summary line of ScalaDoc's method description.
  See collection.immutable.Stack's sortBy.
  Additionally, it looks nicer this way.
- Fixes the typo mentioned in SI-5666.
  • Loading branch information
soc committed May 2, 2012
1 parent 90d2bee commit 65b9fec4b1981c3e10c27cd41fd8cac054e7b05c
Showing with 182 additions and 180 deletions.
  1. +1 −1 src/compiler/scala/tools/nsc/backend/icode/GenICode.scala
  2. +2 −2 src/library/rootdoc.txt
  3. +1 −1 src/library/scala/Array.scala
  4. +1 −1 src/library/scala/Option.scala
  5. +1 −1 src/library/scala/collection/BitSet.scala
  6. +1 −1 src/library/scala/collection/BitSetLike.scala
  7. +1 −1 src/library/scala/collection/GenIterableLike.scala
  8. +1 −1 src/library/scala/collection/GenMapLike.scala
  9. +1 −1 src/library/scala/collection/GenTraversableLike.scala
  10. +1 −1 src/library/scala/collection/GenTraversableOnce.scala
  11. +1 −1 src/library/scala/collection/IndexedSeq.scala
  12. +1 −1 src/library/scala/collection/IndexedSeqLike.scala
  13. +1 −1 src/library/scala/collection/Iterable.scala
  14. +1 −1 src/library/scala/collection/LinearSeq.scala
  15. +1 −1 src/library/scala/collection/Map.scala
  16. +1 −1 src/library/scala/collection/Seq.scala
  17. +7 −7 src/library/scala/collection/SeqLike.scala
  18. +1 −1 src/library/scala/collection/Set.scala
  19. +1 −1 src/library/scala/collection/concurrent/Map.scala
  20. +1 −1 src/library/scala/collection/generic/ArrayTagTraversableFactory.scala
  21. +1 −1 src/library/scala/collection/generic/BitSetFactory.scala
  22. +1 −1 src/library/scala/collection/generic/GenMapFactory.scala
  23. +1 −1 src/library/scala/collection/generic/GenSetFactory.scala
  24. +1 −1 src/library/scala/collection/generic/GenTraversableFactory.scala
  25. +1 −1 src/library/scala/collection/generic/GenericCompanion.scala
  26. +1 −1 src/library/scala/collection/generic/GenericParCompanion.scala
  27. +1 −1 src/library/scala/collection/generic/Growable.scala
  28. +1 −1 src/library/scala/collection/generic/ImmutableSortedMapFactory.scala
  29. +2 −2 src/library/scala/collection/generic/ImmutableSortedSetFactory.scala
  30. +2 −2 src/library/scala/collection/generic/MutableSortedSetFactory.scala
  31. +1 −1 src/library/scala/collection/generic/ParFactory.scala
  32. +1 −1 src/library/scala/collection/generic/ParMapFactory.scala
  33. +1 −1 src/library/scala/collection/generic/Shrinkable.scala
  34. +2 −2 src/library/scala/collection/immutable/BitSet.scala
  35. +1 −1 src/library/scala/collection/immutable/GenSeq.scala.disabled
  36. +1 −1 src/library/scala/collection/immutable/GenSet.scala.disabled
  37. +2 −2 src/library/scala/collection/immutable/HashMap.scala
  38. +3 −3 src/library/scala/collection/immutable/HashSet.scala
  39. +1 −1 src/library/scala/collection/immutable/IndexedSeq.scala
  40. +2 −2 src/library/scala/collection/immutable/IntMap.scala
  41. +2 −2 src/library/scala/collection/immutable/Iterable.scala
  42. +1 −1 src/library/scala/collection/immutable/LinearSeq.scala
  43. +2 −2 src/library/scala/collection/immutable/List.scala
  44. +2 −2 src/library/scala/collection/immutable/LongMap.scala
  45. +1 −1 src/library/scala/collection/immutable/Map.scala
  46. +1 −1 src/library/scala/collection/immutable/NumericRange.scala
  47. +1 −1 src/library/scala/collection/immutable/PagedSeq.scala
  48. +2 −2 src/library/scala/collection/immutable/Queue.scala
  49. +2 −2 src/library/scala/collection/immutable/Seq.scala
  50. +2 −2 src/library/scala/collection/immutable/Set.scala
  51. +2 −2 src/library/scala/collection/immutable/SortedSet.scala
  52. +2 −2 src/library/scala/collection/immutable/Stack.scala
  53. +4 −4 src/library/scala/collection/immutable/Stream.scala
  54. +1 −1 src/library/scala/collection/immutable/StringLike.scala
  55. +1 −1 src/library/scala/collection/immutable/StringOps.scala
  56. +1 −1 src/library/scala/collection/immutable/Traversable.scala
  57. +2 −2 src/library/scala/collection/immutable/TreeSet.scala
  58. +1 −1 src/library/scala/collection/immutable/Vector.scala
  59. +1 −1 src/library/scala/collection/immutable/WrappedString.scala
  60. +2 −2 src/library/scala/collection/mutable/ArrayBuffer.scala
  61. +1 −1 src/library/scala/collection/mutable/ArrayLike.scala
  62. +1 −1 src/library/scala/collection/mutable/ArrayOps.scala
  63. +2 −2 src/library/scala/collection/mutable/ArraySeq.scala
  64. +2 −2 src/library/scala/collection/mutable/ArrayStack.scala
  65. +2 −2 src/library/scala/collection/mutable/BitSet.scala
  66. +2 −2 src/library/scala/collection/mutable/Buffer.scala
  67. +1 −1 src/library/scala/collection/mutable/BufferProxy.scala
  68. +1 −1 src/library/scala/collection/mutable/ConcurrentMap.scala
  69. +2 −2 src/library/scala/collection/mutable/DoubleLinkedList.scala
  70. +1 −1 src/library/scala/collection/mutable/DoubleLinkedListLike.scala
  71. +1 −1 src/library/scala/collection/mutable/GenSeq.scala.disabled
  72. +1 −1 src/library/scala/collection/mutable/GenSet.scala.disabled
  73. +1 −1 src/library/scala/collection/mutable/GrowingBuilder.scala
  74. +2 −2 src/library/scala/collection/mutable/HashMap.scala
  75. +2 −2 src/library/scala/collection/mutable/HashSet.scala
  76. +1 −1 src/library/scala/collection/mutable/IndexedSeq.scala
  77. +1 −1 src/library/scala/collection/mutable/IndexedSeqLike.scala
  78. +1 −1 src/library/scala/collection/mutable/Iterable.scala
  79. +2 −2 src/library/scala/collection/mutable/LinearSeq.scala
  80. +2 −2 src/library/scala/collection/mutable/LinkedHashMap.scala
  81. +2 −2 src/library/scala/collection/mutable/LinkedHashSet.scala
  82. +2 −2 src/library/scala/collection/mutable/LinkedList.scala
  83. +1 −1 src/library/scala/collection/mutable/LinkedListLike.scala
  84. +2 −2 src/library/scala/collection/mutable/ListBuffer.scala
  85. +2 −2 src/library/scala/collection/mutable/ListMap.scala
  86. +1 −1 src/library/scala/collection/mutable/Map.scala
  87. +1 −1 src/library/scala/collection/mutable/MultiMap.scala
  88. +2 −2 src/library/scala/collection/mutable/OpenHashMap.scala
  89. +1 −1 src/library/scala/collection/mutable/Queue.scala
  90. +2 −2 src/library/scala/collection/mutable/Seq.scala
  91. +2 −2 src/library/scala/collection/mutable/Set.scala
  92. +2 −2 src/library/scala/collection/mutable/SortedSet.scala
  93. +2 −2 src/library/scala/collection/mutable/Stack.scala
  94. +1 −1 src/library/scala/collection/mutable/SynchronizedBuffer.scala
  95. +1 −1 src/library/scala/collection/mutable/SynchronizedMap.scala
  96. +1 −1 src/library/scala/collection/mutable/SynchronizedPriorityQueue.scala
  97. +1 −1 src/library/scala/collection/mutable/SynchronizedQueue.scala
  98. +1 −1 src/library/scala/collection/mutable/SynchronizedSet.scala
  99. +1 −1 src/library/scala/collection/mutable/SynchronizedStack.scala
  100. +1 −1 src/library/scala/collection/mutable/Traversable.scala
  101. +1 −1 src/library/scala/collection/mutable/TreeSet.scala
  102. +1 −1 src/library/scala/collection/mutable/UnrolledBuffer.scala
  103. +2 −2 src/library/scala/collection/mutable/WeakHashMap.scala
  104. +1 −1 src/library/scala/collection/mutable/WrappedArray.scala
  105. +1 −1 src/library/scala/collection/parallel/ParIterable.scala
  106. +2 −2 src/library/scala/collection/parallel/immutable/ParHashMap.scala
  107. +2 −2 src/library/scala/collection/parallel/immutable/ParHashSet.scala
  108. +1 −1 src/library/scala/collection/parallel/immutable/ParNumericRange.scala.disabled
  109. +1 −1 src/library/scala/collection/parallel/immutable/ParRange.scala
  110. +2 −2 src/library/scala/collection/parallel/immutable/ParSeq.scala
  111. +2 −2 src/library/scala/collection/parallel/immutable/ParSet.scala
  112. +2 −2 src/library/scala/collection/parallel/immutable/ParVector.scala
  113. +2 −2 src/library/scala/collection/parallel/mutable/ParArray.scala
  114. +1 −1 src/library/scala/collection/parallel/mutable/ParFlatHashTable.scala
  115. +2 −2 src/library/scala/collection/parallel/mutable/ParHashMap.scala
  116. +2 −2 src/library/scala/collection/parallel/mutable/ParHashSet.scala
  117. +2 −2 src/library/scala/collection/parallel/mutable/ParSeq.scala
  118. +2 −2 src/library/scala/collection/parallel/mutable/ParSet.scala
  119. +8 −6 src/library/scala/reflect/api/Types.scala
@@ -821,7 +821,7 @@ abstract class GenICode extends SubComponent {
ctx2

case _ =>
abort("Cannot instantiate " + tpt + "of kind: " + generatedType)
abort("Cannot instantiate " + tpt + " of kind: " + generatedType)
}

case Apply(fun @ _, List(expr)) if (definitions.isBox(fun.symbol)) =>
@@ -22,6 +22,6 @@ Many other packages exist. See the complete list on the left.

Identifiers in the scala package and the [[scala.Predef]] object are always in scope by default.

Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example, List is an alias for scala.collection.immutable.[[scala.collection.immutable.List]].
Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example, `List` is an alias for scala.collection.immutable.[[scala.collection.immutable.List]].

Other aliases refer to classes providing by the underlying platform. For example, on the JVM, String is an alias for java.lang.String.
Other aliases refer to classes provided by the underlying platform. For example, on the JVM, `String` is an alias for `java.lang.String`.
@@ -468,7 +468,7 @@ object Array extends FallbackArrayBuilding {
* @see [[http://www.scala-lang.org/docu/files/collections-api/collections_38.html#anchor "The Scala 2.8 Collections' API"]]
* section on `Array` by Martin Odersky for more information.
* @define coll array
* @define Coll Array
* @define Coll `Array`
* @define orderDependent
* @define orderDependentFold
* @define mayNotTerminateInf
@@ -83,7 +83,7 @@ object Option {
* @define p `p`
* @define f `f`
* @define coll option
* @define Coll Option
* @define Coll `Option`
* @define orderDependent
* @define orderDependentFold
* @define mayNotTerminateInf
@@ -22,7 +22,7 @@ trait BitSet extends SortedSet[Int]

/** $factoryInfo
* @define coll bitset
* @define Coll BitSet
* @define Coll `BitSet`
*/
object BitSet extends BitSetFactory[BitSet] {
val empty: BitSet = immutable.BitSet.empty
@@ -30,7 +30,7 @@ import mutable.StringBuilder
* @version 2.8
* @since 2.8
* @define coll bitset
* @define Coll BitSet
* @define Coll `BitSet`
*/
trait BitSetLike[+This <: BitSetLike[This] with SortedSet[Int]] extends SortedSetLike[Int, This] { self =>

@@ -16,7 +16,7 @@ import generic.{ CanBuildFrom => CBF, _ }
* This trait contains abstract methods and methods that can be implemented
* directly in terms of other methods.
*
* @define Coll GenIterable
* @define Coll `GenIterable`
* @define coll general iterable collection
*
* @author Martin Odersky
@@ -11,7 +11,7 @@ package scala.collection
/** A trait for all maps upon which operations may be
* implemented in parallel.
*
* @define Coll GenMap
* @define Coll `GenMap`
* @define coll general map
* @author Martin Odersky
* @author Aleksandar Prokopec
@@ -43,7 +43,7 @@ import annotation.migration
* @define traversableInfo
* This is a base trait of all kinds of Scala collections.
*
* @define Coll GenTraversable
* @define Coll `GenTraversable`
* @define coll general collection
* @define collectExample
* @tparam A the collection element type.
@@ -14,7 +14,7 @@ package scala.collection
* Methods in this trait are either abstract or can be implemented in terms
* of other methods.
*
* @define Coll GenTraversableOnce
* @define Coll `GenTraversableOnce`
* @define coll collection or iterator
* @define possiblyparinfo
* This trait may possibly have operations implemented in parallel.
@@ -26,7 +26,7 @@ trait IndexedSeq[+A] extends Seq[A]
/** $factoryInfo
* The current default implementation of a $Coll is a `Vector`.
* @define coll indexed sequence
* @define Coll IndexedSeq
* @define Coll `IndexedSeq`
*/
object IndexedSeq extends SeqFactory[IndexedSeq] {
implicit def canBuildFrom[A]: CanBuildFrom[Coll, A, IndexedSeq[A]] = ReusableCBF.asInstanceOf[GenericCanBuildFrom[A]]
@@ -26,7 +26,7 @@ import scala.annotation.tailrec
* access and length computation. They are defined in terms of abstract methods
* `apply` for indexing and `length`.
*
* Indexed sequences do not add any new methods wrt `Seq`, but promise
* Indexed sequences do not add any new methods to `Seq`, but promise
* efficient implementations of random access patterns.
*
* @tparam A the element type of the $coll
@@ -40,7 +40,7 @@ trait Iterable[+A] extends Traversable[A]
/** $factoryInfo
* The current default implementation of a $Coll is a `Vector`.
* @define coll iterable collection
* @define Coll Iterable
* @define Coll `Iterable`
*/
object Iterable extends TraversableFactory[Iterable] {

@@ -26,7 +26,7 @@ trait LinearSeq[+A] extends Seq[A]
/** $factoryInfo
* The current default implementation of a $Coll is a `Vector`.
* @define coll linear sequence
* @define Coll LinearSeq
* @define Coll `LinearSeq`
*/
object LinearSeq extends SeqFactory[LinearSeq] {
implicit def canBuildFrom[A]: CanBuildFrom[Coll, A, LinearSeq[A]] = ReusableCBF.asInstanceOf[GenericCanBuildFrom[A]]
@@ -33,7 +33,7 @@ trait Map[A, +B] extends Iterable[(A, B)] with GenMap[A, B] with MapLike[A, B, M
}

/** $factoryInfo
* @define Coll Map
* @define Coll `Map`
* @define coll map
*/
object Map extends MapFactory[Map] {
@@ -27,7 +27,7 @@ trait Seq[+A] extends PartialFunction[Int, A]
/** $factoryInfo
* The current default implementation of a $Coll is a `List`.
* @define coll sequence
* @define Coll Seq
* @define Coll `Seq`
*/
object Seq extends SeqFactory[Seq] {
/** $genericCanBuildFromInfo */
@@ -45,7 +45,7 @@ import scala.math.Ordering
* @version 1.0, 16/07/2003
* @since 2.8
*
* @define Coll Seq
* @define Coll `Seq`
* @define coll sequence
* @define thatinfo the class of the returned collection. Where possible, `That` is
* the same class as the current collection class `Repr`, but this
@@ -380,8 +380,8 @@ trait SeqLike[+A, +Repr] extends Any with IterableLike[A, Repr] with GenSeqLike[
* $mayNotTerminateInf
*
* @param elem the element to test.
* @return `true` if this $coll has an element that is
* is equal (wrt `==`) to `elem`, `false` otherwise.
* @return `true` if this $coll has an element that is equal (as
* determined by `==`) to `elem`, `false` otherwise.
*/
def contains(elem: Any): Boolean = exists (_ == elem)

@@ -553,8 +553,8 @@ trait SeqLike[+A, +Repr] extends Any with IterableLike[A, Repr] with GenSeqLike[
/** Sorts this $coll according to a comparison function.
* $willNotTerminateInf
*
* The sort is stable. That is, elements that are equal wrt `lt` appear in the
* same order in the sorted sequence as in the original.
* The sort is stable. That is, elements that are equal (as determined by
* `lt`) appear in the same order in the sorted sequence as in the original.
*
* @param lt the comparison function which tests whether
* its first argument precedes its second argument in
@@ -592,8 +592,8 @@ trait SeqLike[+A, +Repr] extends Any with IterableLike[A, Repr] with GenSeqLike[

/** Sorts this $coll according to an Ordering.
*
* The sort is stable. That is, elements that are equal wrt `lt` appear in the
* same order in the sorted sequence as in the original.
* The sort is stable. That is, elements that are equal (as determined by
* `lt`) appear in the same order in the sorted sequence as in the original.
*
* @see scala.math.Ordering
*
@@ -35,7 +35,7 @@ trait Set[A] extends (A => Boolean)
* The current default implementation of a $Coll is one of `EmptySet`, `Set1`, `Set2`, `Set3`, `Set4` in
* class `immutable.Set` for sets of sizes up to 4, and a `immutable.HashSet` for sets of larger sizes.
* @define coll set
* @define Coll Set
* @define Coll `Set`
*/
object Set extends SetFactory[Set] {
def newBuilder[A] = immutable.Set.newBuilder[A]
@@ -19,7 +19,7 @@ package scala.collection.concurrent
* @tparam A the key type of the map
* @tparam B the value type of the map
*
* @define Coll ConcurrentMap
* @define Coll `ConcurrentMap`
* @define coll concurrent map
* @define concurrentmapinfo
* This is a base trait for all Scala concurrent map implementations. It
@@ -15,7 +15,7 @@ import language.higherKinds
* subclasses thereof.
*
* @define coll collection
* @define Coll Traversable
* @define Coll `Traversable`
* @define genericCanBuildFromInfo
* The standard `CanBuildFrom` instance for $Coll objects.
* @author Aleksandar Prokopec
@@ -15,7 +15,7 @@ import scala.collection._
import mutable.Builder

/** @define coll collection
* @define Coll Traversable
* @define Coll `Traversable`
* @define factoryInfo
* This object provides a set of operations to create `$Coll` values.
* @author Martin Odersky
@@ -15,7 +15,7 @@ import language.higherKinds
/** A template for companion objects of `Map` and subclasses thereof.
*
* @define coll map
* @define Coll Map
* @define Coll `Map`
* @define factoryInfo
* This object provides a set of operations needed to create `$Coll` values.
* @author Martin Odersky
@@ -17,7 +17,7 @@ import language.higherKinds
/** A template for companion objects of `Set` and subclasses thereof.
*
* @define coll set
* @define Coll Set
* @define Coll `Set`
* @define factoryInfo
* This object provides a set of operations needed to create `$Coll` values.
* @author Martin Odersky
@@ -19,7 +19,7 @@ import language.higherKinds
* @since 2.8
*
* @define coll collection
* @define Coll Traversable
* @define Coll `Traversable`
* @define factoryInfo
* This object provides a set of operations to create `$Coll` values.
* @author Martin Odersky
@@ -20,7 +20,7 @@ import language.higherKinds
* @author Martin Odersky
* @since 2.8
* @define coll collection
* @define Coll CC
* @define Coll `CC`
*/
abstract class GenericCompanion[+CC[X] <: GenTraversable[X]] {
/** The underlying collection type with unknown element type */
@@ -16,7 +16,7 @@ import language.higherKinds
/** A template class for companion objects of parallel collection classes.
* They should be mixed in together with `GenericCompanion` type.
*
* @define Coll ParIterable
* @define Coll `ParIterable`
* @tparam CC the type constructor representing the collection class
* @since 2.8
*/
@@ -18,7 +18,7 @@ package generic
* @version 2.8
* @since 2.8
* @define coll growable collection
* @define Coll Growable
* @define Coll `Growable`
* @define add add
* @define Add add
*/
@@ -16,7 +16,7 @@ import language.higherKinds
/** A template for companion objects of `SortedMap` and subclasses thereof.
*
* @since 2.8
* @define Coll SortedMap
* @define Coll `SortedMap`
* @define coll sorted map
* @define factoryInfo
* This object provides a set of operations needed to create sorted maps of type `$Coll`.
@@ -16,8 +16,8 @@ import language.higherKinds
/** A template for companion objects of `SortedSet` and subclasses thereof.
*
* @since 2.8
* @define Coll immutable.SortedSet
* @define coll immutable sorted
* @define Coll `immutable.SortedSet`
* @define coll immutable sorted set
* @define factoryInfo
* This object provides a set of operations needed to create sorted sets of type `$Coll`.
* @author Martin Odersky
@@ -13,8 +13,8 @@ import scala.collection.mutable.{ Builder, GrowingBuilder }
import language.higherKinds

/**
* @define Coll mutable.SortedSet
* @define coll mutable sorted
* @define Coll `mutable.SortedSet`
* @define coll mutable sorted set
*
* @author Lucien Pereira
*
@@ -17,7 +17,7 @@ import language.higherKinds
* operations to create `$Coll` objects.
*
* @define coll parallel collection
* @define Coll ParIterable
* @define Coll `ParIterable`
* @since 2.8
*/
abstract class ParFactory[CC[X] <: ParIterable[X] with GenericParTemplate[X, CC]]
@@ -19,7 +19,7 @@ import language.higherKinds
* to create `$Coll` objects.
*
* @define coll parallel map
* @define Coll ParMap
* @define Coll `ParMap`
* @author Aleksandar Prokopec
* @since 2.8
*/
@@ -17,7 +17,7 @@ package generic
* @version 2.8
* @since 2.8
* @define coll shrinkable collection
* @define Coll Shrinkable
* @define Coll `Shrinkable`
*/
trait Shrinkable[-A] {

@@ -20,7 +20,7 @@ import mutable.{ Builder, SetBuilder }
* @see [[http://docs.scala-lang.org/overviews/collections/concrete-immutable-collection-classes.html#immutable_bitsets "Scala's Collection Library overview"]]
* section on `Immutable BitSets` for more information.
*
* @define Coll immutable.BitSet
* @define Coll `immutable.BitSet`
* @define coll immutable bitset
*/
@SerialVersionUID(1611436763290191562L)
@@ -63,7 +63,7 @@ abstract class BitSet extends scala.collection.AbstractSet[Int]
}

/** $factoryInfo
* @define Coll immutable.BitSet
* @define Coll `immutable.BitSet`
* @define coll immutable bitset
*/
object BitSet extends BitSetFactory[BitSet] {
@@ -25,7 +25,7 @@ import mutable.Builder
*
* The class adds an `update` method to `collection.Seq`.
*
* @define Coll mutable.Seq
* @define Coll `mutable.Seq`
* @define coll mutable sequence
*/
trait GenSeq[+A] extends GenIterable[A]
@@ -24,7 +24,7 @@ import mutable.Builder
*
* @since 1.0
* @author Matthias Zenger
* @define Coll mutable.Set
* @define Coll `mutable.Set`
* @define coll mutable set
*/
trait GenSet[A] extends GenIterable[A]
@@ -27,7 +27,7 @@ import parallel.immutable.ParHashMap
* @since 2.3
* @see [[http://docs.scala-lang.org/overviews/collections/concrete-immutable-collection-classes.html#hash_tries "Scala's Collection Library overview"]]
* section on `Hash Tries` for more information.
* @define Coll immutable.HashMap
* @define Coll `immutable.HashMap`
* @define coll immutable hash map
* @define mayNotTerminateInf
* @define willNotTerminateInf
@@ -96,7 +96,7 @@ class HashMap[A, +B] extends AbstractMap[A, B]
}

/** $factoryInfo
* @define Coll immutable.HashMap
* @define Coll `immutable.HashMap`
* @define coll immutable hash map
*
* @author Tiark Rompf

0 comments on commit 65b9fec

Please sign in to comment.
You can’t perform that action at this time.