From 1e06aca8e3babe3b288b0599e1e55402ce454fe5 Mon Sep 17 00:00:00 2001 From: Szabolcs Berecz Date: Thu, 23 Feb 2012 22:33:18 +0100 Subject: update api docs for @elidable to match the behaviour more closely. --- src/library/scala/annotation/elidable.scala | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'src/library') 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 ` 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._ -- cgit v1.2.3