Can I mark a function as deprecated in Scala?

Question

I'd like Scala compiler to show a deprecation warning whenever a particular function is found used. How can I achieve this?

score 38 · Accepted Answer · answered Feb 20 '12 at 02:15

38

Annotate it as @deprecated.

answered Feb 20 '12 at 02:15

Daniel C. Sobral

22

And if you don't want deprecation warnings about your deprecation annotations, make sure you supply them with both `message` and `since` arguments. – Kristian Domagala Feb 20 '12 at 03:26
1

Fixed link: https://www.scala-lang.org/api/2.12.1/scala/deprecated.html – Jeff Evans Oct 28 '19 at 17:29

score 36 · Answer 2 · edited Aug 01 '14 at 11:15

36

I didn't notice the comment, kristian-domagala, so here is the example:

@deprecated("Reason this is old","01-08-2014")
def oldMethod = {          
  ...      
}

edited Aug 01 '14 at 11:15

Ciaran

answered Jan 04 '13 at 17:14

flapjack

2

Now it's: @deprecated("don't use this", "01/01/2014") – gwenzek Jul 22 '14 at 21:58
3

The `since` argument needn't be a date, in fact the docs specify it as "a string identifying the first version in which the definition was deprecated". – Todd Owen Apr 10 '15 at 07:48
1

@ToddOwen True, I find it useful to put in the commit hash there for example. – Bar Sep 06 '16 at 13:41

2 Answers2