summaryrefslogtreecommitdiff
path: root/src/library/scala/Unit.scala
diff options
context:
space:
mode:
authorHeather Miller <heather.miller@epfl.ch>2011-09-18 07:43:05 +0000
committerHeather Miller <heather.miller@epfl.ch>2011-09-18 07:43:05 +0000
commit3f58f66c8b2147d728467da9ede91cdcf60a4a8d (patch)
tree67516df06e4269d7c02b04adb03b51ab4dbe8179 /src/library/scala/Unit.scala
parentbe9e2991d90384797781767c58616d4ae04796e8 (diff)
downloadscala-3f58f66c8b2147d728467da9ede91cdcf60a4a8d.tar.gz
scala-3f58f66c8b2147d728467da9ede91cdcf60a4a8d.tar.bz2
scala-3f58f66c8b2147d728467da9ede91cdcf60a4a8d.zip
Small changes to the API documentation of the A...
Small changes to the API documentation of the AnyVal types. Contributed by Michael Allman during the September doc spree. No review.
Diffstat (limited to 'src/library/scala/Unit.scala')
-rwxr-xr-xsrc/library/scala/Unit.scala7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/library/scala/Unit.scala b/src/library/scala/Unit.scala
index 0059ded33a..57970b021b 100755
--- a/src/library/scala/Unit.scala
+++ b/src/library/scala/Unit.scala
@@ -11,9 +11,10 @@
package scala
-/** `Unit` (equivalent to Java's `void` type) is a subtype of [[scala.AnyVal]], meaning that
- * it is not represented by an object in the underlying runtime system. There is
- * only one value of type `Unit`: `()`.
+/** `Unit` is a subtype of [[scala.AnyVal]]. There is only one value of type
+ * `Unit`, `()`, and it is not represented by any object in the underlying
+ * runtime system. A method with return type `Unit` is analogous to a Java
+ * method which is declared `void`.
*/
final class Unit extends AnyVal {
def getClass(): Class[Unit] = sys.error("stub")