lost of documentation and some small adjustment...

lost of documentation and some small adjustments to collection classes.

1 files changed, 9 insertions, 7 deletions

diff --git a/src/library/scala/collection/mutable/BitSet.scala b/src/library/scala/collection/mutable/BitSet.scala
index 2744c04b24..92dad18956 100644
--- a/src/library/scala/collection/mutable/BitSet.scala
+++ b/src/library/scala/collection/mutable/BitSet.scala
@@ -16,7 +16,10 @@ import generic._
 import BitSetLike.{LogWL, updateArray}
 
 /** A class for mutable bitsets.
+ *  $bitsetinfo
  *
+ *  @author Martin Odersky
+ *  @version 2.8
  *  @since 1
  */
 @serializable @SerialVersionUID(8483111450368547763L)
@@ -48,9 +51,6 @@ class BitSet(protected var elems: Array[Long]) extends Set[Int]
 
   protected def fromArray(words: Array[Long]): BitSet = new BitSet(words)
 
-  /** Adds element to bitset,
-   *  @return element was already present.
-   */
   override def add(elem: Int): Boolean = {
     require(elem >= 0)
     if (contains(elem)) false
@@ -61,9 +61,6 @@ class BitSet(protected var elems: Array[Long]) extends Set[Int]
     }
   }
 
-  /** Removes element from bitset.
-   *  @return element was already present.
-   */
   override def remove(elem: Int): Boolean = {
     require(elem >= 0)
     if (contains(elem)) {
@@ -79,6 +76,11 @@ class BitSet(protected var elems: Array[Long]) extends Set[Int]
   override def clear() {
     elems = new Array[Long](elems.length)
   }
+
+  /** Wraps this bitset as an immutable bitset backed by the array of bits
+   *  of this bitset.
+   *  @note Subsequent changes in this bitset will be reflected in the returned immutable bitset.
+   */
   def toImmutable = immutable.BitSet.fromArray(elems)
 
   override def clone(): BitSet = {
@@ -88,8 +90,8 @@ class BitSet(protected var elems: Array[Long]) extends Set[Int]
   }
 }
 
-/** A factory object for mutable bitsets */
 object BitSet extends BitSetFactory[BitSet] {
   def empty: BitSet = new BitSet
+  /** $canBuildFromInfo */
   implicit def canBuildFrom: CanBuildFrom[BitSet, Int, BitSet] = bitsetCanBuildFrom
 }