...
| Code Block |
|---|
|
"deprecated": "true" // a boolean as a string; this just means "deprecated" without any extra info (it is a string and not a boolean directly in case you want to provide more information about the deprecation; see below) |
| Code Block |
|---|
|
"deprecated": "This component will be removed in version X.", // some extra message explaining to the developer why it was deprecated or what to use instead |
In the case when the "replacement" property is used (supported for component level deprecation only), the generated markers for the used deprecated components will also have a quickfix quick-fix.
| Code Block |
|---|
|
"deprecated": "This component will be removed in version X.",//some extra message
"replacement": "packagename-compname" |
Using only the "replacement" property only will also mark the component as deprecated, and the generated marker will have have a quickfixquick-fix.
| Code Block |
|---|
|
"replacement": "packagename-compname" |
...
| Info |
|---|
| title | The "deprecated" property |
|---|
|
The "deprecated" property can also be used to deprecate service/component api or component properties: e.g. service function removeKeyListener
{
"true",
"Please use removeKeyListener(...) instead.",
"parameters": |
e.g. component property
{
{
"enabled" : {"type": "boolean", "default": true, "deprecated": "true"}, |
In this case, the deprecated property will not be shown in the properties view. |
...