com.google.template.soy.shared.restricted

Annotation Type SoyDeprecated

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface SoyDeprecated

Annotation for SoyFunction or SoyPrintDirective types that marks it as deprecated.

This will trigger warnings from the Soy compiler.

NOTE: don't use Deprecated for a few reasons:

1. It doesn't provide a mechanism to associate an author defined comment. This is more helpful for Soy plugins because it is often difficult to navigate from plugin use to definition, whereas in Java this is a more standardized and supported workflow.
2. It allows authors to distinguish between deprecated implementations (for which Deprecated would be appropriate ) and deprecated Soy plugins (for which this annotation is appropriate.)
3. It requires an explicit opt-in to prevent author confusion by adding a new behavior to Deprecated.