scala.deprecatedName.scala Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of scala-library Show documentation
Show all versions of scala-library Show documentation
Standard library for the Scala Programming Language
/* __ *\
** ________ ___ / / ___ Scala API **
** / __/ __// _ | / / / _ | (c) 2010-2013, LAMP/EPFL **
** __\ \/ /__/ __ |/ /__/ __ | http://scala-lang.org/ **
** /____/\___/_/ |_/____/_/ | | **
** |/ **
\* */
package scala
import scala.annotation.meta._
/**
* An annotation that designates the name of the parameter to which it is
* applied as deprecated. Using that name in a named argument generates
* a deprecation warning.
*
* For instance, evaluating the code below in the Scala interpreter
* {{{
* def inc(x: Int, @deprecatedName('y) n: Int): Int = x + n
* inc(1, y = 2)
* }}}
* will produce the following output:
* {{{
* warning: there were 1 deprecation warnings; re-run with -deprecation for details
* res0: Int = 3
* }}}
*
* @since 2.8.1
*/
@param
class deprecatedName(name: Symbol) extends scala.annotation.StaticAnnotation