Basic scaladoc for Vector.

This gives a minimal introduction, and sets a number of macros so that
inherited documentation is clearer.

Contributed by Greg Price.

1 files changed, 18 insertions, 0 deletions

diff --git a/src/library/scala/collection/immutable/Vector.scala b/src/library/scala/collection/immutable/Vector.scala
index 4ed838c7a3..c7b4614c21 100644
--- a/src/library/scala/collection/immutable/Vector.scala
+++ b/src/library/scala/collection/immutable/Vector.scala
@@ -33,6 +33,24 @@ object Vector extends SeqFactory[Vector] {
 // in principle, most members should be private. however, access privileges must
 // be carefully chosen to not prevent method inlining
 
+/** A class implementing an immutable indexed sequence.
+ *
+ * @tparam A the element type
+ *
+ *  @define Coll Vector
+ *  @define coll vector
+ *  @define thatinfo the class of the returned collection. In the standard library configuration,
+ *    `That` is always `Vector[B]` because an implicit of type `CanBuildFrom[Vector, B, That]`
+ *    is defined in object `Vector`.
+ *  @define bfinfo an implicit value of class `CanBuildFrom` which determines the
+ *    result class `That` from the current representation type `Repr`
+ *    and the new element type `B`. This is usually the `canBuildFrom` value
+ *    defined in object `Vector`.
+ *  @define orderDependent
+ *  @define orderDependentFold
+ *  @define mayNotTerminateInf
+ *  @define willNotTerminateInf
+ */
 final class Vector[+A](private[collection] val startIndex: Int, private[collection] val endIndex: Int, focus: Int)
 extends IndexedSeq[A]
    with GenericTraversableTemplate[A, Vector]