Scaladoc clean-ups for various actor and channe...

Scaladoc clean-ups for various actor and channel types. Actor now
extends InputChannel. Channel now extends CanReply. Review by plocinic.

1 files changed, 9 insertions, 7 deletions

diff --git a/src/actors/scala/actors/InputChannel.scala b/src/actors/scala/actors/InputChannel.scala
index fa2fad43c6..dfe26b3462 100644
--- a/src/actors/scala/actors/InputChannel.scala
+++ b/src/actors/scala/actors/InputChannel.scala
@@ -15,11 +15,13 @@ package scala.actors
  * for all channels from which values can be received.
  *
  * @author Philipp Haller
+ *
+ * @define channel `InputChannel`
  */
 trait InputChannel[+Msg] {
 
   /**
-   * Receives a message from this <code>InputChannel</code>.
+   * Receives a message from this $channel.
    *
    * @param  f    a partial function with message patterns and actions
    * @return      result of processing the received value
@@ -27,7 +29,7 @@ trait InputChannel[+Msg] {
   def receive[R](f: PartialFunction[Msg, R]): R
 
   /**
-   * Receives a message from this <code>InputChannel</code> within
+   * Receives a message from this $channel within
    * a certain time span.
    *
    * @param  msec the time span before timeout
@@ -37,8 +39,8 @@ trait InputChannel[+Msg] {
   def receiveWithin[R](msec: Long)(f: PartialFunction[Any, R]): R
 
   /**
-   * Receives a message from this <code>InputChannel</code>.
-   * <p>
+   * Receives a message from this $channel.
+   *
    * This method never returns. Therefore, the rest of the computation
    * has to be contained in the actions of the partial function.
    *
@@ -47,9 +49,9 @@ trait InputChannel[+Msg] {
   def react(f: PartialFunction[Msg, Unit]): Nothing
 
   /**
-   * Receives a message from this <code>InputChannel</code> within
+   * Receives a message from this $channel within
    * a certain time span.
-   * <p>
+   *
    * This method never returns. Therefore, the rest of the computation
    * has to be contained in the actions of the partial function.
    *
@@ -59,7 +61,7 @@ trait InputChannel[+Msg] {
   def reactWithin(msec: Long)(f: PartialFunction[Any, Unit]): Nothing
 
   /**
-   * Receives the next message from this <code>Channel</code>.
+   * Receives the next message from this $channel.
    */
   def ? : Msg
 }