summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Odersky <odersky@gmail.com>2010-04-09 17:28:31 +0000
committerMartin Odersky <odersky@gmail.com>2010-04-09 17:28:31 +0000
commit8fc50d2aa738670f6018ec58fd26979631b772f6 (patch)
tree581f67760a688f69427dea538c6f92a756e276cf
parent261e399ba3a11a5844e057526a6161970b75e8d3 (diff)
downloadscala-8fc50d2aa738670f6018ec58fd26979631b772f6.tar.gz
scala-8fc50d2aa738670f6018ec58fd26979631b772f6.tar.bz2
scala-8fc50d2aa738670f6018ec58fd26979631b772f6.zip
more docs
-rw-r--r--src/library/scala/collection/BitSet.scala8
-rwxr-xr-xsrc/library/scala/collection/LinearSeqOptimized.scala6
-rw-r--r--src/library/scala/collection/SeqView.scala2
-rw-r--r--src/library/scala/collection/generic/TraversableFactory.scala4
-rw-r--r--src/library/scala/collection/immutable/BitSet.scala6
-rw-r--r--src/library/scala/collection/immutable/List.scala5
-rw-r--r--src/library/scala/collection/mutable/BitSet.scala4
-rw-r--r--src/library/scala/collection/mutable/IndexedSeq.scala6
-rw-r--r--src/library/scala/collection/mutable/IndexedSeqView.scala2
-rw-r--r--src/library/scala/collection/mutable/LinearSeq.scala6
-rw-r--r--src/library/scala/collection/mutable/Seq.scala5
11 files changed, 25 insertions, 29 deletions
diff --git a/src/library/scala/collection/BitSet.scala b/src/library/scala/collection/BitSet.scala
index abb4856bcd..59acb2922e 100644
--- a/src/library/scala/collection/BitSet.scala
+++ b/src/library/scala/collection/BitSet.scala
@@ -15,17 +15,15 @@ import generic._
/** A common base class for mutable and immutable bitsets.
* $bitsetinfo
-
- * @author Martin Odersky
- * @version 2.8
- * @since 1
*/
trait BitSet extends Set[Int]
with BitSetLike[BitSet] {
override def empty: BitSet = BitSet.empty
}
-/** $factoryInfo */
+/** $factoryInfo
+ * @define coll bitset
+ */
object BitSet extends BitSetFactory[BitSet] {
val empty: BitSet = immutable.BitSet.empty
/** $canBuildFromInfo */
diff --git a/src/library/scala/collection/LinearSeqOptimized.scala b/src/library/scala/collection/LinearSeqOptimized.scala
index 7d3c58ad85..2add28d7c3 100755
--- a/src/library/scala/collection/LinearSeqOptimized.scala
+++ b/src/library/scala/collection/LinearSeqOptimized.scala
@@ -20,12 +20,6 @@ import scala.util.control.Breaks._
* the implementation of several methods under the assumption of fast linear access.
*
* $linearSeqInfo
- * @author Martin Odersky
- * @version 2.8
- * @since 2.8
- *
- * @tparam A the element type of the $coll
- * @tparam Repr the type of the actual $coll containing the elements.
*/
trait LinearSeqOptimized[+A, +Repr <: LinearSeqOptimized[A, Repr]] extends LinearSeqLike[A, Repr] { self: Repr =>
diff --git a/src/library/scala/collection/SeqView.scala b/src/library/scala/collection/SeqView.scala
index 79d50f1de6..9a0025bd81 100644
--- a/src/library/scala/collection/SeqView.scala
+++ b/src/library/scala/collection/SeqView.scala
@@ -22,6 +22,8 @@ import TraversableView.NoBuilder
trait SeqView[+A, +Coll] extends SeqViewLike[A, Coll, SeqView[A, Coll]]
/** $factoryInfo
+ * @define coll sequence view
+ * @define Coll SeqView
*/
object SeqView {
type Coll = TraversableView[_, C] forSome {type C <: Traversable[_]}
diff --git a/src/library/scala/collection/generic/TraversableFactory.scala b/src/library/scala/collection/generic/TraversableFactory.scala
index c2668b48a2..b7fda70922 100644
--- a/src/library/scala/collection/generic/TraversableFactory.scala
+++ b/src/library/scala/collection/generic/TraversableFactory.scala
@@ -17,8 +17,8 @@ package generic
*
* @since 2.8
*
- * @define $coll collection
- * @define @Coll Traversable
+ * @define coll collection
+ * @define Coll Traversable
* @define factoryInfo
* This object provides a set of operations to create `$Coll` values.
* @author Martin Odersky
diff --git a/src/library/scala/collection/immutable/BitSet.scala b/src/library/scala/collection/immutable/BitSet.scala
index f644ce08e9..857b537904 100644
--- a/src/library/scala/collection/immutable/BitSet.scala
+++ b/src/library/scala/collection/immutable/BitSet.scala
@@ -15,12 +15,8 @@ package immutable
import generic._
import BitSetLike.{LogWL, updateArray}
-/** A base class for immutable bit sets.x
+/** A class for immutable bitsets.
* $bitsetinfo
- *
- * @author Martin Odersky
- * @version 2.8
- * @since 1
*/
@serializable @SerialVersionUID(1611436763290191562L)
abstract class BitSet extends Set[Int]
diff --git a/src/library/scala/collection/immutable/List.scala b/src/library/scala/collection/immutable/List.scala
index 2b91ab8852..4ce441ca55 100644
--- a/src/library/scala/collection/immutable/List.scala
+++ b/src/library/scala/collection/immutable/List.scala
@@ -433,7 +433,10 @@ final case class ::[B](private var hd: B, private[scala] var tl: List[B]) extend
}
}
-/** $factoryInfo */
+/** $factoryInfo
+ * @define coll list
+ * @define Coll List
+ */
object List extends SeqFactory[List] {
import scala.collection.{Iterable, Seq, IndexedSeq}
diff --git a/src/library/scala/collection/mutable/BitSet.scala b/src/library/scala/collection/mutable/BitSet.scala
index 92dad18956..388aa4dc43 100644
--- a/src/library/scala/collection/mutable/BitSet.scala
+++ b/src/library/scala/collection/mutable/BitSet.scala
@@ -17,10 +17,6 @@ import BitSetLike.{LogWL, updateArray}
/** A class for mutable bitsets.
* $bitsetinfo
- *
- * @author Martin Odersky
- * @version 2.8
- * @since 1
*/
@serializable @SerialVersionUID(8483111450368547763L)
class BitSet(protected var elems: Array[Long]) extends Set[Int]
diff --git a/src/library/scala/collection/mutable/IndexedSeq.scala b/src/library/scala/collection/mutable/IndexedSeq.scala
index 0a173395e0..631a4abfc9 100644
--- a/src/library/scala/collection/mutable/IndexedSeq.scala
+++ b/src/library/scala/collection/mutable/IndexedSeq.scala
@@ -17,8 +17,6 @@ import generic._
/** A subtrait of <code>collection.IndexedSeq</code> which represents sequences
* that can be mutated.
* $indexedSeqInfo
- *
- * @since 2.8
*/
trait IndexedSeq[A] extends Seq[A]
with scala.collection.IndexedSeq[A]
@@ -27,6 +25,10 @@ trait IndexedSeq[A] extends Seq[A]
override def companion: GenericCompanion[IndexedSeq] = IndexedSeq
}
+/** $factoryInfo
+ * @define coll indexed sequence
+ * @define Coll IndexedSeq
+ */
object IndexedSeq extends SeqFactory[IndexedSeq] {
implicit def canBuildFrom[A]: CanBuildFrom[Coll, A, IndexedSeq[A]] = new GenericCanBuildFrom[A]
def newBuilder[A]: Builder[A, IndexedSeq[A]] = new ArrayBuffer[A]
diff --git a/src/library/scala/collection/mutable/IndexedSeqView.scala b/src/library/scala/collection/mutable/IndexedSeqView.scala
index d870b762d3..9a0e7a4010 100644
--- a/src/library/scala/collection/mutable/IndexedSeqView.scala
+++ b/src/library/scala/collection/mutable/IndexedSeqView.scala
@@ -92,6 +92,8 @@ self =>
}
/** $factoryInfo
+ * @define coll indexed sequence view
+ * @define Coll IndexedSeqView
* Note that the canBuildFrom factories yield SeqViews, not IndexedSewqViews.
* This is intentional, because not all operations yield again a mutable.IndexedSeqView.
* For instance, map just gives a SeqView, which reflects the fact that
diff --git a/src/library/scala/collection/mutable/LinearSeq.scala b/src/library/scala/collection/mutable/LinearSeq.scala
index 9abaef5aff..23ad4b8c29 100644
--- a/src/library/scala/collection/mutable/LinearSeq.scala
+++ b/src/library/scala/collection/mutable/LinearSeq.scala
@@ -17,8 +17,6 @@ import generic._
/** A subtrait of <code>collection.LinearSeq</code> which represents sequences
* that can be mutated.
* $linearSeqInfo
- *
- * @since 2.8
*/
trait LinearSeq[A] extends Seq[A]
with scala.collection.LinearSeq[A]
@@ -27,6 +25,10 @@ trait LinearSeq[A] extends Seq[A]
override def companion: GenericCompanion[LinearSeq] = LinearSeq
}
+/** $factoryInfo
+ * @define coll linear sequence
+ * @define Coll LinearSeq
+ */
object LinearSeq extends SeqFactory[LinearSeq] {
implicit def canBuildFrom[A]: CanBuildFrom[Coll, A, LinearSeq[A]] = new GenericCanBuildFrom[A]
def newBuilder[A]: Builder[A, LinearSeq[A]] = new MutableList[A]
diff --git a/src/library/scala/collection/mutable/Seq.scala b/src/library/scala/collection/mutable/Seq.scala
index a57d397275..8d11e14063 100644
--- a/src/library/scala/collection/mutable/Seq.scala
+++ b/src/library/scala/collection/mutable/Seq.scala
@@ -16,9 +16,10 @@ import generic._
/** A subtrait of <code>collection.Seq</code> which represents sequences
* that can be mutated.
- * The class adds an <code>update</code> method to <code>collection.Seq</code>.
*
- * @since 2.8
+ * $seqInfo
+ *
+ * The class adds an <code>update</code> method to <code>collection.Seq</code>.
*/
trait Seq[A] extends Iterable[A]
with scala.collection.Seq[A]