vdldoc:deprecated

Deprecated (v2.1+)

The vdldoc:deprecated element can be used to let developers know that the tag has been deprecated. When this element is used on a tag, its name and attribute name(s) will be strikethrough formatted. If specified, a deprecation message for the tag will preceed the tag description.

Example taglib.xml usage:

<tag>
    ...
    <description>This is a:oldTag.</description>
    <tag-name>oldTag</tag-name>
    ...
    <tag-extension>
        ...
        <vdldoc:deprecated>Please use a:newTag instead.</vdldoc:deprecated>
        ...
    </tag-extension>
    ...
</tag>

Example composite component usage:

<cc:interface shortDescription="This is a:oldTag.">
    ...
    <cc:extension>
        ...
        <vdldoc:deprecated value="Please use a:newTag instead." />
        ...
    </cc:extension>
    ...
</cc:interface>

Note: The composite component tag will accept both the value and the shortDescription attributes as the description for the deprecation. If both attributes appear on the element, then the shortDescription is used.

Sample Tag Page Output:

...

Tag column

Description:

      Deprecated. Please use a:newTag instead. This is a:oldTag.

...

---