blob: f8c6bd32ad7747155e0b337badc9d450ed672de9 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
|
/* __ *\
** ________ ___ / / ___ Scala API **
** / __/ __// _ | / / / _ | (c) 2010-2013, LAMP/EPFL **
** __\ \/ /__/ __ |/ /__/ __ | http://scala-lang.org/ **
** /____/\___/_/ |_/____/_/ | | **
** |/ **
\* */
package scala
import scala.annotation.meta._
/** 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)
* ^
* }}}
*
* @since 2.8.1
* @see [[scala.deprecated]]
* @see [[scala.deprecatedInheritance]]
* @see [[scala.deprecatedOverriding]]
*/
@param
class deprecatedName(name: Symbol = Symbol("<none>"), since: String = "") extends scala.annotation.StaticAnnotation
|
