apiItemName

The <apiItemName> element provides the name for substructure of an interface such as parameter of an operation or subfield of a method.

Description

The <apiItemName> element has the following attributes: keyref and outputclass.

For example, if the description of the API item is not available, you must provide the name of the related API item inside the <apiDefItem> element and the fully qualified name of the element in the keyref attribute.

Example

The following example shows a simple <apiItemName> element for a Visual Basic method:

<apiOperation id="com.ibm.xtools.rational.xde" outputclass=”IRXEAbstraction”>
     <apiName></apiName>
     <shortdesc></shortdesc>
     <apiOperationDetail>
     <apiOperationDef>
         
         <apiParam>
           <apiType name="type" value="int"/>
           <apiArray name="array" value="array"/>
           <apiItemName>num</apiItemName>
         </apiParam>
         <apiParam>
           <apiType name="type" value="string"/>
           <apiItemName>map</apiItemName>
           <apiDefItem>Contains mapping of SQL type names.</apiDefItem>
         </apiParam>
      </apiOperationDef>
   </apiOperationDetail
</apiOperation>

Contained by

apiClassifierDef, apiClassifierMember, apiConstructorDef, apiDef, apiDefItem, apiEvent, apiOperationDef, apiOperationDefItem, apiParam, apiReturn, apiSyntaxItem, apiSyntaxText, apiValueDef, apiValueMember

Content model

(text data) (any number)

Inheritance

topic/keyword reference/keyword