diff options
author | Martin Odersky <odersky@gmail.com> | 2010-04-13 17:36:21 +0000 |
---|---|---|
committer | Martin Odersky <odersky@gmail.com> | 2010-04-13 17:36:21 +0000 |
commit | e20c986ba1668abd5f561095aa64cf153cd48227 (patch) | |
tree | 6d77d7aa3d537f76dcf985bdbf46172ea369ec5e /src/library/scala/collection/SetLike.scala | |
parent | 174c1721ff3b1b581142ad0ed80a655d2d0b4aba (diff) | |
download | scala-e20c986ba1668abd5f561095aa64cf153cd48227.tar.gz scala-e20c986ba1668abd5f561095aa64cf153cd48227.tar.bz2 scala-e20c986ba1668abd5f561095aa64cf153cd48227.zip |
more documentation
Diffstat (limited to 'src/library/scala/collection/SetLike.scala')
-rw-r--r-- | src/library/scala/collection/SetLike.scala | 37 |
1 files changed, 23 insertions, 14 deletions
diff --git a/src/library/scala/collection/SetLike.scala b/src/library/scala/collection/SetLike.scala index 15e3ef43ca..5a16b975df 100644 --- a/src/library/scala/collection/SetLike.scala +++ b/src/library/scala/collection/SetLike.scala @@ -14,20 +14,21 @@ import generic._ import mutable.{Builder, AddingBuilder} import PartialFunction._ -/** A template trait for sets of type `Set[A]`. +/** A template trait for sets. * - * This trait provides most of the operations of a `Set` independently of its representation. - * It is typically inherited by concrete implementations of sets. + * $setNote + * $setTags + * @since 2.8 * - * $setnote + * @define setNote * - * @tparam A the type of the elements of the set - * @tparam This the type of the set itself. + * A set is a collection that contains no duplicate elements. * - * @author Martin Odersky - * @version 2.8 - * @define setnote - * To implement a concrete set, you need to provide implementations of the + * '''Implementation note:''' + * This trait provides most of the operations of a `Set` independently of its representation. + * It is typically inherited by concrete implementations of sets. + * + * To implement a concrete set, you need to provide implementations of the * following methods: * {{{ * def contains(key: A): Boolean @@ -42,10 +43,18 @@ import PartialFunction._ * }}} * It is also good idea to override methods `foreach` and * `size` for efficiency. - * @define coll set - * @define Coll Set - * @define willNotTerminateInf - * @define mayNotTerminateInf + * + * @define setTags + * @tparam A the type of the elements of the set + * @tparam This the type of the set itself. + * + * @author Martin Odersky + * @version 2.8 + * + * @define coll set + * @define Coll Set + * @define willNotTerminateInf + * @define mayNotTerminateInf */ trait SetLike[A, +This <: SetLike[A, This] with Set[A]] extends IterableLike[A, This] |