apiOtherClassifier

The <apiOtherClassifier> element provides the type for a member classifier.

Description

The <apiOtherClassifier> element can provide an href attribute if the description of the API item is available. If the description is not available, the <apiOtherClassifier> element can provide the name of the API item in its contents.
  • If you use an href attribute to a DITA API topic that describes the related API item, you do not need any other attributes.
  • If you provide an href attribute to some other format (such as HTML), you need to supply the name of the related API item inside the <apiOtherClassifier> element.
  • If you cannot provide an href (for instance, if the description of the related API item might not be available), you must provide the name of the related API item inside the <apiOtherClassifier> element and the fully qualified name of the element in the keyref attribute. The keyref attribute must provide a unique key such as a fully qualified classifier name for the named API item.

Example

The following example shows a simple <apiOtherClassifier> element for a VB.NET API class:
<apiClassifier id="rational.xde" outputclass="class" platform="vb">
    <apiName>RXEAbstractClass</apiName>
    <shortdesc>Specifies one or more interfaces or interface members that will be implemented
        in the class or structure definition in which it appears.</shortdesc>
    <apiClassifierDetail>
       <apiClassifierDef>
			<!–
          Public MustInherit Class RXEAbstractClass
       –>
          <apiQualifier name="access" value="public"/>
          <apiBaseClassifier>
            <apiItemName href=”IRXEClass”>IRXEClass</apiItemName>
            <apiDefNote>Required. A class whose properties, methods, and events will be
                implemented by corresponding members in a class or structure.</apiDefNote>
          </apiBaseClassifier>
          <apiOtherClassifier>
            <apiItemName href=”RXEAbstractClass”>RXEAbstractClass</apiItemName>
            <apiDefNote>Required. A class whose properties, methods, and events will be
                implemented by corresponding members in a class or structure.</apiDefNote>
          </apiOtherClassifier>
          <apiClassifierMember><apiItemName>RXEAbstraction</apiItemName>
          </apiClassifierMember>
       </apiClassifierDef>
	</apiClassifierDetail>
</apiClassifier>

Contained by

apiClassifierMember

Content model

(text data) (any number)

Inheritance

topic/xref reference/xref apiRef/apiRelation