<apiname>

An API name is the name of an application programming interface (API), such as a Java class name or method name.

Specialization hierarchy

The <apiname> element is specialized from <keyword>. It is defined in the programming domain module.

Content model

(Text | <text> )*

Zero or more
  • Text
  • <text>

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@keyref
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

Example

This section is non-normative.

The following code sample shows how the <apiname> element can be used to identify the document.write method:

<p>Use the <apiname>document.write</apiname> method to create text 
output in the dynamically constructed view.</p>