diff options
author | Aleksandar Pokopec <aleksandar.prokopec@epfl.ch> | 2010-04-10 15:20:46 +0000 |
---|---|---|
committer | Aleksandar Pokopec <aleksandar.prokopec@epfl.ch> | 2010-04-10 15:20:46 +0000 |
commit | e2decb09ed9cbfad6e1c61b68e24423620d01ff3 (patch) | |
tree | a7970f709b9ebaf3f63d6865bc76c45f1c653cff /src/library/scala/collection/mutable/History.scala | |
parent | 519214dcc68c941afb45ef6e749ec0afdb10af65 (diff) | |
download | scala-e2decb09ed9cbfad6e1c61b68e24423620d01ff3.tar.gz scala-e2decb09ed9cbfad6e1c61b68e24423620d01ff3.tar.bz2 scala-e2decb09ed9cbfad6e1c61b68e24423620d01ff3.zip |
More docs. No review.
Diffstat (limited to 'src/library/scala/collection/mutable/History.scala')
-rw-r--r-- | src/library/scala/collection/mutable/History.scala | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/src/library/scala/collection/mutable/History.scala b/src/library/scala/collection/mutable/History.scala index 40ebfe5fa5..ffa3d6481a 100644 --- a/src/library/scala/collection/mutable/History.scala +++ b/src/library/scala/collection/mutable/History.scala @@ -13,14 +13,17 @@ package scala.collection package mutable -/** <code>History[A, B]</code> objects may subscribe to events of - * type <code>A</code> published by an object of type <code>B</code>. +/** `History[A, B]` objects may subscribe to events of + * type `A` published by an object of type `B`. * The history subscriber object records all published events - * up to maximum number of <code>maxHistory</code> events. + * up to maximum number of `maxHistory` events. * * @author Matthias Zenger * @version 1.0, 08/07/2003 * @since 1 + * + * @tparam Evt Type of events. + * @tparam Pub Type of publishers. */ @serializable @SerialVersionUID(5219213543849892588L) @@ -29,9 +32,10 @@ class History[Evt, Pub] extends Subscriber[Evt, Pub] with Iterable[(Pub, Evt)] protected val log: Queue[(Pub, Evt)] = new Queue val maxHistory: Int = 1000 - /** - * @param pub ... - * @param event ... + /** Notifies this listener with an event by enqueuing it in the log. + * + * @param pub the publisher. + * @param event the event. */ def notify(pub: Pub, event: Evt) { if (log.length >= maxHistory) |