UFT Test Object Schema > Elements > Documentation Element

Documentation Element

Description

The documentation string for the operation.

Important Information

The documentation string appears in the Documentation column of the Keyword View, when a step is created with the relevant operation.

Documentation strings for UFT built in operations are phrased as instructions and include the relevant operation arguments. For example: "Set the MyBar progress bar to position 3." You may want to create similar strings for your operations.

You can use plain text together with one or more of the following dynamic placeholders within the documentation string:
%l    The name of the test object.
%t    The test object's generic type.
%a1   %a2   %a3 ...   The value of the relevant argument.

For example, the documentation string could be written as "Click the %l %t at coordinates %a1, %a2." In the Documentation column of the Keyword View, this could appear as "Click the Beach image at coordinates 190, 170."

Note:

  • If you use dynamic placeholders in the string, you need to place the entire string inside a CDATA section, to instruct the string to be ignored by the XML parser. A CDATA section starts with <![CDATA[ and ends with ]]>.
  • Do not include dynamic placeholders for optional arguments.

Attributes

Name Type Use Default Description
NumOfArguments integer optional 0 The number of arguments that require values to be specified in order to show the documentation string for the operation. This attribute is currently not in use.

Used By

Source

<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="Documentation">
    <xs:annotation>
        <xs:documentation>The documentation string for the operation.</xs:documentation>
    </xs:annotation>
    <xs:complexType>
        <xs:simpleContent>
            <xs:extension base="xs:string">
                <xs:attribute name="NumOfArguments" type="xs:integer" use="optional" default="0">
                    <xs:annotation>
                        <xs:documentation>The number of arguments that require values to be specified in order to show the documentation string for the operation. This attribute is currently not in use.</xs:documentation>
                    </xs:annotation>
                </xs:attribute>
            </xs:extension>
        </xs:simpleContent>
    </xs:complexType>
</xs:element>