Template:DeprecatedAPI/documentation

From ReliaWiki
Jump to navigation Jump to search


Template Documentation

This is a boilerplate template for Synthesis API methods and properties that have been deprecated (i.e., marked for removal in future versions of the API).

Usage

This template requires two parameters:

1 - Indicate whether it is a method or property.
2 - Add the link to the new or recommended method/property.


For example, the following code will generate a template for a deprecated method that has been replaced with the Repository.Model.GetAllModels method:


{{Template:DeprecatedAPI|method|[[Repository.Model.GetAllModels]]}}

The output appears as follows:

This method has been deprecated and may be removed in future versions of the Synthesis API. Do not use it in new applications. Repository.Model.GetAllModels