diff options
| author | Szabolcs Berecz <szabolcs.berecz@gmail.com> | 2012-02-23 22:33:18 +0100 |
|---|---|---|
| committer | Szabolcs Berecz <szabolcs.berecz@gmail.com> | 2012-02-23 22:33:18 +0100 |
| commit | 1e06aca8e3babe3b288b0599e1e55402ce454fe5 (patch) | |
| tree | 3bf368be08b5f18f58f63fe5eeee5ba866b10997 /src/library/scala/annotation/elidable.scala | |
| parent | 622656dfc87100bc94a37f3b244955c96d526023 (diff) | |
| download | scala-1e06aca8e3babe3b288b0599e1e55402ce454fe5.tar.gz scala-1e06aca8e3babe3b288b0599e1e55402ce454fe5.tar.bz2 scala-1e06aca8e3babe3b288b0599e1e55402ce454fe5.zip | |
update api docs for @elidable to match the behaviour more closely.
Diffstat (limited to 'src/library/scala/annotation/elidable.scala')
| -rw-r--r-- | src/library/scala/annotation/elidable.scala | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/src/library/scala/annotation/elidable.scala b/src/library/scala/annotation/elidable.scala index 8dc180d7ab..145c404a28 100644 --- a/src/library/scala/annotation/elidable.scala +++ b/src/library/scala/annotation/elidable.scala @@ -10,12 +10,15 @@ package scala.annotation import java.util.logging.Level -/** An annotation for methods for which invocations might - * be removed in the generated code. +/** An annotation for methods whose body might be removed in the generated + * code. * * Behavior is influenced by passing `-Xelide-below <arg>` to `scalac`. - * Methods marked elidable will be omitted from generated code if the - * priority given the annotation is lower than to the command line argument. + * The body of methods marked elidable will be omitted from generated code + * if the priority given the annotation is lower than to the command line + * argument. If the method has a result type other than Unit, its return + * value will be the zero value of the type (0 for numeric types, false for + * boolean and null for reference types). * Examples: * {{{ * import annotation.elidable._ |