vdldoc:deprecation

Deprecation (v1.2-2.1)

Note: the vdldoc:deprecation element has been deprecated as of version 2.1. Please use vdldoc:deprecated instead.

---

The vdldoc:deprecation 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:deprecation>
            <vdldoc:deprecated>true</vdldoc:deprecated>
            <vdldoc:description>Please use a:newTag instead.</vdldoc:description>
        </vdldoc:deprecation>
        ...
    </tag-extension>
    ...
</tag>

Example composite component usage:

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

Sample Tag Page Output:

...

Tag column

Description:

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

...