apiValueClassifier

The <apiValueClassifier> element specifies that the value is an instance of a classifier.

Description

This element can provide an href if the description of the API item is available. If the description is not available, the <apiValueClassifier> element can provide the name of the API item in its contents.

For example, in Java DITA API specialization, the <apiValueClassifier> element represents the javaMethodClass or javaMethodInterface for parameters, and javaFieldClass or javaFieldInterface for fields.

Example

The following example shows an <apiValueClassifier> element for a Visual Basic property:

<apiValue id="IRXEAbstarction.Model" outputclass="property">
    <apiName>Model</apiName>
    <shortDesc>Retrieves the IRXEModel object that the element belongs to.</shortDesc>
      <apiValueDetail>
         <apiValueDef>
            <apiQualifier name="access" value="Public"/>
            <apiType name="type" value="Readonly">
            <apiValueClassifier href="IRXEModel.dita">IRXEModel</apiValueClassifier>
            <apiRelation href=”../IRXEAbstarction_intf.dita”>IRXEAbstarction Interface</apiRelation>
            <apiDefNote>
                Returns the <keyword>IRXEModel</keyword> object that the element belongs to.
            </apiDefNote>
         </apiValueDef>
      </apiValueDetail>
      <apiDesc>
         <note>You must have an open read action before calling this property.</note>
     </apiDesc>
</apiValue>

Contained by

apiValueDef, apiValueMember

Content model

(text data) (any number)

Inheritance

topic/xref reference/xref apiRef/apiRelation