aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorphaller <hallerp@gmail.com>2012-11-12 15:49:41 +0100
committerphaller <hallerp@gmail.com>2012-11-12 15:49:41 +0100
commit7df70c7617c93fe7c0033448cc1e93cc8ebbe3e0 (patch)
treeac6227b3ace07082fe8b2d415dcdf8075513b223
parent415d277d931033d00b96f78d9a8f3e06c6df79c2 (diff)
downloadscala-async-7df70c7617c93fe7c0033448cc1e93cc8ebbe3e0.tar.gz
scala-async-7df70c7617c93fe7c0033448cc1e93cc8ebbe3e0.tar.bz2
scala-async-7df70c7617c93fe7c0033448cc1e93cc8ebbe3e0.zip
Fix doc comment of await
-rw-r--r--src/main/scala/scala/async/Async.scala14
1 files changed, 7 insertions, 7 deletions
diff --git a/src/main/scala/scala/async/Async.scala b/src/main/scala/scala/async/Async.scala
index 4f7fa01..dac35d5 100644
--- a/src/main/scala/scala/async/Async.scala
+++ b/src/main/scala/scala/async/Async.scala
@@ -53,14 +53,14 @@ abstract class AsyncBase {
/**
* A call to `await` must be nested in an enclosing `async` block.
- *
- * A call to await does not block the thread, rather it is a delimiter
+ *
+ * A call to `await` does not block the current thread, rather it is a delimiter
* used by the enclosing `async` macro. Code following the `await`
- * call.
- *
- * @param awaitable The future from which a value is awaited
- * @tparam T The type of that value
- * @return The value
+ * call is executed asynchronously, when the argument of `await` has been completed.
+ *
+ * @param awaitable the future from which a value is awaited.
+ * @tparam T the type of that value.
+ * @return the value.
*/
// TODO Replace with `@compileTimeOnly when this is implemented SI-6539
@deprecated("`await` must be enclosed in an `async` block", "0.1")