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 call. (Deprecated means that the method call is marked for removal in future versions of the API.)

Usage
This template has 2 optional string parameters:


 * 1 = Allows you to indicate whether the deprecated call is a class or enumeration. The default value is "method."
 * 2 = Allows you to append additional text to the message in the text box.

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

The code output is as follows:

The next example shows how to use the 2nd parameter:

The code output is as follows:

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