From 7f9dd2d49f7e088228f98c6e4083a61e801d9b44 Mon Sep 17 00:00:00 2001 From: Peter Vlugter Date: Fri, 6 May 2011 12:31:02 +1200 Subject: [PATCH] Fix scaladoc errors --- .../src/main/scala/akka/actor/ActorRegistry.scala | 10 +++++----- .../src/main/scala/akka/actor/TypedActor.scala | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/akka-actor/src/main/scala/akka/actor/ActorRegistry.scala b/akka-actor/src/main/scala/akka/actor/ActorRegistry.scala index c833c6d360..310aa19c78 100644 --- a/akka-actor/src/main/scala/akka/actor/ActorRegistry.scala +++ b/akka-actor/src/main/scala/akka/actor/ActorRegistry.scala @@ -286,7 +286,7 @@ class Index[K <: AnyRef,V <: AnyRef : Manifest] { /** * Associates the value of type V with the key of type K - * @returns true if the value didn't exist for the key previously, and false otherwise + * @return true if the value didn't exist for the key previously, and false otherwise */ def put(key: K, value: V): Boolean = { //Tailrecursive spin-locking put @@ -328,7 +328,7 @@ class Index[K <: AnyRef,V <: AnyRef : Manifest] { } /** - * @returns a _new_ array of all existing values for the given key at the time of the call + * @return a _new_ array of all existing values for the given key at the time of the call */ def values(key: K): Array[V] = { val set: JSet[V] = container get key @@ -337,7 +337,7 @@ class Index[K <: AnyRef,V <: AnyRef : Manifest] { } /** - * @returns Some(value) for the first matching value where the supplied function returns true for the given key, + * @return Some(value) for the first matching value where the supplied function returns true for the given key, * if no matches it returns None */ def findValue(key: K)(f: (V) => Boolean): Option[V] = { @@ -359,7 +359,7 @@ class Index[K <: AnyRef,V <: AnyRef : Manifest] { /** * Disassociates the value of type V from the key of type K - * @returns true if the value was disassociated from the key and false if it wasn't previously associated with the key + * @return true if the value was disassociated from the key and false if it wasn't previously associated with the key */ def remove(key: K, value: V): Boolean = { val set = container get key @@ -377,7 +377,7 @@ class Index[K <: AnyRef,V <: AnyRef : Manifest] { } /** - * @returns true if the underlying containers is empty, may report false negatives when the last remove is underway + * @return true if the underlying containers is empty, may report false negatives when the last remove is underway */ def isEmpty: Boolean = container.isEmpty diff --git a/akka-typed-actor/src/main/scala/akka/actor/TypedActor.scala b/akka-typed-actor/src/main/scala/akka/actor/TypedActor.scala index 36af9b9784..77d0d1e64d 100644 --- a/akka-typed-actor/src/main/scala/akka/actor/TypedActor.scala +++ b/akka-typed-actor/src/main/scala/akka/actor/TypedActor.scala @@ -559,7 +559,7 @@ object TypedActor { * Factory method for remote typed actor. * @param intfClass interface the typed actor implements * @param targetClass implementation class of the typed actor - * @paramm timeout timeout for future + * @param timeout timeout for future * @param host hostname of the remote server * @param port port of the remote server */ @@ -572,7 +572,7 @@ object TypedActor { * Factory method for remote typed actor. * @param intfClass interface the typed actor implements * @param factory factory method that constructs the typed actor - * @paramm timeout timeout for future + * @param timeout timeout for future * @param host hostname of the remote server * @param port port of the remote server */ @@ -585,7 +585,7 @@ object TypedActor { * Factory method for typed actor. * @param intfClass interface the typed actor implements * @param factory factory method that constructs the typed actor - * @paramm config configuration object forthe typed actor + * @param config configuration object for the typed actor */ def newInstance[T](intfClass: Class[T], factory: => AnyRef, config: TypedActorConfiguration): T = newInstance(intfClass, createActorRef(newTypedActor(factory),config), config) @@ -607,7 +607,7 @@ object TypedActor { * Factory method for typed actor. * @param intfClass interface the typed actor implements * @param targetClass implementation class of the typed actor - * @paramm config configuration object forthe typed actor + * @param config configuration object for the typed actor */ def newInstance[T](intfClass: Class[T], targetClass: Class[_], config: TypedActorConfiguration): T = newInstance(intfClass, createActorRef(newTypedActor(targetClass),config), config)