deprecatedName

scala.deprecatedName
class deprecatedName(name: String, since: String) extends StaticAnnotation

An annotation that designates that the name of a parameter is deprecated.

Using this name in a named argument generates a deprecation warning.

Library authors should state the library's deprecation policy in their documentation to give developers guidance on how long a deprecated name will be preserved.

Library authors should prepend the name of their library to the version number to help developers distinguish deprecations coming from different libraries:

def inc(x: Int, @deprecatedName("y", "FooLib 12.0") n: Int): Int = x + n
inc(1, y = 2)

will produce the following warning:

warning: the parameter name y is deprecated (since FooLib 12.0): use n instead
inc(1, y = 2)
         ^

Attributes

See also:
Source:
deprecatedName.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Deprecated constructors

def this(name: Symbol, since: String)

Attributes

Deprecated
true
Source:
deprecatedName.scala
def this(name: Symbol)

Attributes

Deprecated
true
Source:
deprecatedName.scala