info.magnolia.annotation.deprecation

Annotation Type MgnlDeprecated

@Documented
 @Retention(value=RUNTIME)
 @Target(value={METHOD,TYPE})
public @interface MgnlDeprecated

An annotation to capture information regarding Deprecated classes and/or methods.

This annotation is present in order to provide extra information about the Deprecated classes and therefore any Deprecated classes should be annotated with Deprecated annotation explicitly.

Usage:

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	since Defines 'since' which version the particular class and/or method is deprecated.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description Should be utilised to elaborate the reasoning of deprecation.

Element Detail

since

public abstract String since

Defines 'since' which version the particular class and/or method is deprecated.

description

public abstract String description

Should be utilised to elaborate the reasoning of deprecation.

Default:

""