Template:Leaking Nasal disclaimer

From FlightGear wiki
Jump to: navigation, search
CautionImproper use of the foo() API may cause resource leaks.

This typically is caused by the low-level nature of such code, requiring manual tracking of listeners and timers and manual reset and re-init handling.

It is instead recommended that you use the bar() API. Alternatively a wrapping helper class can be used to handle low-level APIs, which is the recommended way to support multiple FlightGear versions.

The following template description is not displayed when the template is inserted in an article.

Goal

This template can be used to caution about that improper use of a low-level Nasal API may cause resource leaks.

Usage

This template is meant for use within a section.

{{leaking Nasal disclaimer
| oldapi = 
| newapi = 
}}

Both parameters are optional. It is possible to use links to the APIs.

oldapi
Older low-level API. Defaults to foo().
newapi
Newer high-level API. Defaults to bar().