apiName

The <apiName> element provides the name of an application programming interface (API).

Description

The <apiName> element is contained not only by the <apiRef> element, but also by all specialized API topic types.

Example

<javaField id="IRXEAbstraction">
   <apiName>IID</apiName>
   <shortdesc>....</shortdesc>
</javaField>
<apiValue id="parameter">
   <apiName>theNameOPT</apiName>
   
</javaParameter>
<javaPackage>
	 <apiName>com.ibm.xtools.patterns.framework.uml2</apiName>
   <shortdesc>....</shortdesc>
<javaPackage>
<javaMethod>
	 <apiName>getPriority</apiName>
   <shortdesc>....</shortdesc>
<javaMethod>

Contained by

apiClassifier, apiOperation, apiPackage, apiRef, apiValue

Contains

apiname, b, boolean, cmdname, codeph, filepath, i, image, keyword, menucascade, msgnum, msgph, option, parmname, ph, q, state, sub, sup, synph, systemoutput, term, tm, tt, u, uicontrol, userinput, varname, wintitle

Content model

(text data or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or term or q or boolean or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or tm or image) (any number)

Inheritance

topic/title reference/title