diff options
author | michelou <michelou@epfl.ch> | 2011-07-15 16:25:42 +0000 |
---|---|---|
committer | michelou <michelou@epfl.ch> | 2011-07-15 16:25:42 +0000 |
commit | a0476af6bce252a7e724e6e99e50a80f0021ce78 (patch) | |
tree | 8d1cc42b8ae676330d776e7b722afa623585818b /src/library/scala/Product.scala | |
parent | d79493bb728b4d47a1e333a0d8451b8e73c08041 (diff) | |
download | scala-a0476af6bce252a7e724e6e99e50a80f0021ce78.tar.gz scala-a0476af6bce252a7e724e6e99e50a80f0021ce78.tar.bz2 scala-a0476af6bce252a7e724e6e99e50a80f0021ce78.zip |
2nd round of clean ups (see r25285)
Diffstat (limited to 'src/library/scala/Product.scala')
-rw-r--r-- | src/library/scala/Product.scala | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/src/library/scala/Product.scala b/src/library/scala/Product.scala index 1dbf46b4c2..cb316f2da3 100644 --- a/src/library/scala/Product.scala +++ b/src/library/scala/Product.scala @@ -8,32 +8,32 @@ package scala -/** Base trait for all products, which in the standard library include at least - * [[scala.Product1]] through [[scala.Product22]] and therefore also their - * subclasses [[scala.Tuple1]] through [[scala.Tuple22]]. In addition, all case - * classes implement Product with synthetically generated methods. +/** Base trait for all products, which in the standard library include at + * least [[scala.Product1]] through [[scala.Product22]] and therefore also + * their subclasses [[scala.Tuple1]] through [[scala.Tuple22]]. In addition, + * all case classes implement `Product` with synthetically generated methods. * * @author Burak Emir * @version 1.0 * @since 2.3 */ trait Product extends Equals { - /** The nth element of this product, 0-based. In other words, for a - * product `A(x_1, ..., x_k)`, returns x_(n+1) where 0 < n < k. + /** The n^th^ element of this product, 0-based. In other words, for a + * product `A(x,,1,,, ..., x,,k,,)`, returns `x,,(n+1),, where `0 < n < k`. * * @param n the index of the element to return - * @throws IndexOutOfBoundsException + * @throws `IndexOutOfBoundsException` * @return the element `n` elements after the first element */ def productElement(n: Int): Any /** The size of this product. - * @return for a product `A(x_1, ..., x_k)`, returns `k` + * @return for a product `A(x,,1,,, ..., x,,k,,)`, returns `k` */ def productArity: Int /** An iterator over all the elements of this product. - * @return in the default implementation, an Iterator[Any] + * @return in the default implementation, an `Iterator[Any]` */ def productIterator: Iterator[Any] = new Iterator[Any] { private var c: Int = 0 @@ -47,7 +47,7 @@ trait Product extends Equals { /** A string used in the `toString` methods of derived classes. * Implementations may override this method to prepend a string prefix - * to the result of toString methods. + * to the result of `toString` methods. * * @return in the default implementation, the empty string */ |