Merge pull request scala#4667 from janekdb/2.11.x-scaladoc-library-library-aux

ScalaDoc fixes for library and library-aux

Author: retronym

src/library-aux/scala/AnyRef.scala

@@ -45,7 +45,7 @@ trait AnyRef extends Any {
    */
   def synchronized[T](body: => T): T
 
-  /** Tests whether the argument (`arg0`) is a reference to the receiver object (`this`).
+  /** Tests whether the argument (`that`) is a reference to the receiver object (`this`).
    *
    *  The `eq` method implements an [[http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]] on
    *  non-null instances of `AnyRef`, and has three additional properties:
@@ -73,7 +73,7 @@ trait AnyRef extends Any {
 
   /** The expression `x == that` is equivalent to `if (x eq null) that eq null else x.equals(that)`.
    *
-   *  @param    arg0  the object to compare against this object for equality.
+   *  @param    that  the object to compare against this object for equality.
    *  @return         `true` if the receiver object is equivalent to the argument; `false` otherwise.
    */
   final def ==(that: Any): Boolean =

src/library/scala/StringContext.scala

@@ -173,7 +173,7 @@ object StringContext {
   /** An exception that is thrown if a string contains a backslash (`\`) character
    *  that does not start a valid escape sequence.
    *  @param  str   The offending string
-   *  @param  idx   The index of the offending backslash character in `str`.
+   *  @param  index   The index of the offending backslash character in `str`.
    */
   class InvalidEscapeException(str: String, @deprecatedName('idx) val index: Int) extends IllegalArgumentException(
     s"""invalid escape ${

src/library/scala/collection/GenSeqLike.scala

@@ -274,7 +274,7 @@ trait GenSeqLike[+A, +Repr] extends Any with GenIterableLike[A, Repr] with Equal
    *  @tparam B        the element type of the returned $coll.
    *  @tparam That     $thatinfo
    *  @param bf        $bfinfo
-   *  @return a new $coll` which is a copy of this $coll with the element at position `index` replaced by `elem`.
+   *  @return a new $coll which is a copy of this $coll with the element at position `index` replaced by `elem`.
    *  @throws IndexOutOfBoundsException if `index` does not satisfy `0 <= index < length`.
    *
    *  @usecase def updated(index: Int, elem: A): $Coll[A]

src/library/scala/collection/immutable/Stream.scala

@@ -1190,7 +1190,7 @@ object Stream extends SeqFactory[Stream] {
     def #:::(prefix: Stream[A]): Stream[A] = prefix append tl
   }
 
-  /** A wrapper method that adds `#::` for cons and `#::: for concat as operations
+  /** A wrapper method that adds `#::` for cons and `#:::` for concat as operations
    *  to streams.
    */
   implicit def consWrapper[A](stream: => Stream[A]): ConsWrapper[A] =

src/library/scala/compat/Platform.scala

@@ -41,7 +41,7 @@ object Platform {
     * @throws java.lang.ArrayStoreException If either `src` or `dest` are not of type
     *                [java.lang.Array]; or if the element type of `src` is not
     *                compatible with that of `dest`.
-    * @throws java.lang.IndexOutOfBoundsException If either srcPos` or `destPos` are
+    * @throws java.lang.IndexOutOfBoundsException If either `srcPos` or `destPos` are
     *                outside of the bounds of their respective arrays; or if `length`
     *                is negative; or if there are less than `length` elements available
     *                after `srcPos` or `destPos` in `src` and `dest` respectively.

src/library/scala/math/BigDecimal.scala

@@ -124,7 +124,7 @@ object BigDecimal {
    */
   def exact(s: String): BigDecimal = exact(new BigDec(s))
 
-  /** Constructs a 'BigDecimal` that exactly represents the number
+  /** Constructs a `BigDecimal` that exactly represents the number
    *  specified in base 10 in a character array.
    */
  def exact(cs: Array[Char]): BigDecimal = exact(new BigDec(cs))

src/library/scala/reflect/Manifest.scala

@@ -248,7 +248,7 @@ object ManifestFactory {
   def arrayType[T](arg: Manifest[_]): Manifest[Array[T]] =
     arg.asInstanceOf[Manifest[T]].arrayManifest
 
-  /** Manifest for the abstract type `prefix # name'. `upperBound` is not
+  /** Manifest for the abstract type `prefix # name`. `upperBound` is not
     * strictly necessary as it could be obtained by reflection. It was
     * added so that erasure can be calculated without reflection. */
   def abstractType[T](prefix: Manifest[_], name: String, upperBound: Predef.Class[_], args: Manifest[_]*): Manifest[T] =
@@ -269,7 +269,7 @@ object ManifestFactory {
         (if (upperBound eq Nothing) "" else " <: "+upperBound)
     }
 
-  /** Manifest for the intersection type `parents_0 with ... with parents_n'. */
+  /** Manifest for the intersection type `parents_0 with ... with parents_n`. */
   def intersectionType[T](parents: Manifest[_]*): Manifest[T] =
     new Manifest[T] {
       def runtimeClass = parents.head.runtimeClass

test/scaladoc/resources/doc-root/AnyRef.scala

@@ -45,7 +45,7 @@ trait AnyRef extends Any {
    */
   def synchronized[T](body: => T): T
 
-  /** Tests whether the argument (`arg0`) is a reference to the receiver object (`this`).
+  /** Tests whether the argument (`that`) is a reference to the receiver object (`this`).
    *
    *  The `eq` method implements an [[http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]] on
    *  non-null instances of `AnyRef`, and has three additional properties:
@@ -73,7 +73,7 @@ trait AnyRef extends Any {
 
   /** The expression `x == that` is equivalent to `if (x eq null) that eq null else x.equals(that)`.
    *
-   *  @param    arg0  the object to compare against this object for equality.
+   *  @param    that  the object to compare against this object for equality.
    *  @return         `true` if the receiver object is equivalent to the argument; `false` otherwise.
    */
   final def ==(that: AnyRef): Boolean =