Template:DeprecatedAPI/documentation

Template Documentation

This boilerplate template is for use with deprecated Synthesis API methods. It inserts a text box that alerts the reader to the deprecated status of the method call. (Deprecated means that the method call is marked for removal in future versions of the API.)

Usage

This template has one optional string parameter. The parameter gives you the option to append additional text to the message in the text box.

For example, the following code shows how to use the optional parameter:

{{Template:DeprecatedAPI| Please use the ABC method going forward.}}

The code output is as follows:

This Please use the ABC method going forward. has been deprecated and may be removed in future versions of the Synthesis API. Do not use it in new applications.

Related Templates

Template:DeprecatedAPIpic - This template is for use with in-line text. It inserts a label that says "Deprecated".