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

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

If thename is omitted, then using the canonical name is deprecated. In that case, lints such as-Xlint:named-booleans which encourage the use of a name will not warn.

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 + ninc(1, y = 2)

will produce the following warning:

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