Packages

a

scala

deprecatedName

class deprecatedName extends Annotation with 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)
         ^
Annotations
@param() @deprecatedInheritance(message = "Scheduled for being final in the future", since = "2.13.0")
Source
deprecatedName.scala
See also

scala.deprecated

scala.deprecatedInheritance

scala.deprecatedOverriding

Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. deprecatedName
  2. StaticAnnotation
  3. Annotation
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new deprecatedName(name: String = "<none>", since: String = "")
  2. new deprecatedName(name: Symbol)
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) The parameter name should be a String, not a symbol.

  3. new deprecatedName(name: Symbol, since: String)
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) The parameter name should be a String, not a symbol.