Template:DeprecatedAPI/documentation: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) (Created page with '__NOTOC__<div style="background-color: #DBE9F4;"> ={{Font|Template Documentation|16|Calibri|bold|black}}= This is a boilerplate template for Synthesis API methods and proper…') |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 8: | Line 8: | ||
==Usage== | ==Usage== | ||
This template | This template requires two parameters: | ||
:1 - Indicate whether it is a method or property. | :1 - Indicate whether it is a method or property. | ||
:2 - Add the link to the new or recommended method/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'' has been replaced with the ''Repository.Model.GetAllModels'' method: | For example, the following code will generate a template for a deprecated ''method'' that has been replaced with the ''Repository.Model.GetAllModels'' method: | ||
<pre> | <pre> | ||
{{Template:DeprecatedAPI|method|[[Repository.Model.GetAllModels]]}} | {{Template:DeprecatedAPI|method|[[Repository.Model.GetAllModels]]}} | ||
Revision as of 21:15, 8 July 2015
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