summaryrefslogtreecommitdiff
path: root/src/actors
diff options
context:
space:
mode:
authorPhilipp Haller <hallerp@gmail.com>2010-04-27 22:10:36 +0000
committerPhilipp Haller <hallerp@gmail.com>2010-04-27 22:10:36 +0000
commitfe0a2ac4c3b393cc3684cf66a4de7c85a29d68fd (patch)
tree4a926a06c8bca01e1e4ac6881d266dab52712362 /src/actors
parent677ca58efb2d759eb674e2e419756afc0e94927d (diff)
downloadscala-fe0a2ac4c3b393cc3684cf66a4de7c85a29d68fd.tar.gz
scala-fe0a2ac4c3b393cc3684cf66a4de7c85a29d68fd.tar.bz2
scala-fe0a2ac4c3b393cc3684cf66a4de7c85a29d68fd.zip
Fixed scaladoc output for several types and mem...
Fixed scaladoc output for several types and members. No review.
Diffstat (limited to 'src/actors')
-rw-r--r--src/actors/scala/actors/Actor.scala30
-rw-r--r--src/actors/scala/actors/Channel.scala17
-rw-r--r--src/actors/scala/actors/remote/RemoteActor.scala27
3 files changed, 33 insertions, 41 deletions
diff --git a/src/actors/scala/actors/Actor.scala b/src/actors/scala/actors/Actor.scala
index c78447b92e..cccb3ce4fb 100644
--- a/src/actors/scala/actors/Actor.scala
+++ b/src/actors/scala/actors/Actor.scala
@@ -116,17 +116,17 @@ object Actor extends Combinators {
}
/**
- * <p>This is a factory method for creating actors.</p>
+ * This is a factory method for creating actors.
*
- * <p>The following example demonstrates its usage:</p>
+ * The following example demonstrates its usage:
*
- * <pre>
+ * {{{
* import scala.actors.Actor._
* ...
* val a = actor {
* ...
* }
- * </pre>
+ * }}}
*
* @param body the code block to be executed by the newly created actor
* @return the newly created actor. Note that it is automatically started.
@@ -141,14 +141,12 @@ object Actor extends Combinators {
}
/**
- * <p>
* This is a factory method for creating actors whose
- * body is defined using a <code>Responder</code>.
- * </p>
+ * body is defined using a `Responder`.
*
- * <p>The following example demonstrates its usage:</p>
+ * The following example demonstrates its usage:
*
- * <pre>
+ * {{{
* import scala.actors.Actor._
* import Responder.exec
* ...
@@ -158,9 +156,9 @@ object Actor extends Combinators {
* if exec(println("result: "+res))
* } yield {}
* }
- * </pre>
+ * }}}
*
- * @param body the <code>Responder</code> to be executed by the newly created actor
+ * @param body the `Responder` to be executed by the newly created actor
* @return the newly created actor. Note that it is automatically started.
*/
def reactor(body: => Responder[Unit]): Actor = {
@@ -274,20 +272,18 @@ object Actor extends Combinators {
def mailboxSize: Int = rawSelf.mailboxSize
/**
- * <p>
* Converts a synchronous event-based operation into
- * an asynchronous <code>Responder</code>.
- * </p>
+ * an asynchronous `Responder`.
*
- * <p>The following example demonstrates its usage:</p>
+ * The following example demonstrates its usage:
*
- * <pre>
+ * {{{
* val adder = reactor {
* for {
* _ <- respondOn(react) { case Add(a, b) => reply(a+b) }
* } yield {}
* }
- * </pre>
+ * }}}
*/
def respondOn[A, B](fun: PartialFunction[A, Unit] => Nothing):
PartialFunction[A, B] => Responder[B] =
diff --git a/src/actors/scala/actors/Channel.scala b/src/actors/scala/actors/Channel.scala
index e40a804e4a..b3772c6109 100644
--- a/src/actors/scala/actors/Channel.scala
+++ b/src/actors/scala/actors/Channel.scala
@@ -11,19 +11,18 @@
package scala.actors
-/** <p>
- * This class is used to pattern match on values that were sent
- * to some channel <code>Chan<sub>n</sub></code> by the current
- * actor <code>self</code>.
- * </p>
- * <p>
- * The following example demonstrates its usage:
- * </p><pre>
+/**
+ * This class is used to pattern match on values that were sent
+ * to some channel <code>Chan<sub>n</sub></code> by the current
+ * actor <code>self</code>.
+ *
+ * The following example demonstrates its usage:
+ * {{{
* receive {
* <b>case</b> Chan1 ! msg1 => ...
* <b>case</b> Chan2 ! msg2 => ...
* }
- * </pre>
+ * }}}
*
* @author Philipp Haller
*/
diff --git a/src/actors/scala/actors/remote/RemoteActor.scala b/src/actors/scala/actors/remote/RemoteActor.scala
index 860ff3bfe3..78361ec0fb 100644
--- a/src/actors/scala/actors/remote/RemoteActor.scala
+++ b/src/actors/scala/actors/remote/RemoteActor.scala
@@ -13,33 +13,30 @@ package scala.actors
package remote
-/** <p>
- * This object provides methods for creating, registering, and
- * selecting remotely accessible actors.
- * </p>
- * <p>
- * A remote actor is typically created like this:
- * </p><pre>
+/**
+ * This object provides methods for creating, registering, and
+ * selecting remotely accessible actors.
+ *
+ * A remote actor is typically created like this:
+ * {{{
* actor {
* alive(9010)
* register('myName, self)
*
* // behavior
* }
- * </pre>
- * <p>
- * It can be accessed by an actor running on a (possibly)
- * different node by selecting it in the following way:
- * </p><pre>
+ * }}}
+ * It can be accessed by an actor running on a (possibly)
+ * different node by selecting it in the following way:
+ * {{{
* actor {
* // ...
- * <b>val</b> c = select(Node("127.0.0.1", 9010), 'myName)
+ * val c = select(Node("127.0.0.1", 9010), 'myName)
* c ! msg
* // ...
* }
- * </pre>
+ * }}}
*
- * @version 0.9.18
* @author Philipp Haller
*/
object RemoteActor {