Pattern: Use of @deprecated tag
Issue: -
This rule reports use of the @deprecated block tag in KDoc comments. Deprecation must be specified using a
@Deprecated annotation as adding a @deprecated block tag in KDoc comments has no effect and is not supported]. The @Deprecated
annotation constructor has dedicated fields for a message and a type (warning, error, etc.). You can also use the
@ReplaceWith annotation to specify how to solve the deprecation automatically via the IDE.
Example of incorrect code:
/**
* This function prints a message followed by a new line.
*
* @deprecated Useless, the Kotlin standard library can already do this. Replace with println.
*/
fun printThenNewline(what: String) {
// ...
}Example of correct code:
/**
* This function prints a message followed by a new line.
*/
@Deprecated("Useless, the Kotlin standard library can already do this.")
@ReplaceWith("println(what)")
fun printThenNewline(what: String) {
// ...
}