apiQualifier

The <apiQualifier> element specifies a semantic flag that qualifies the interface.

Description

This element requires the name and value attributes. Use the name attribute for the name of the flag and the value attribute for the value of the flag.

For example, in the Java API specialization, the <apiQualifier> element represents the access flag (javaClassAccess| javaInterfaceAccess| javaMethodAccess| javaFieldAccess) with a value enumeration of public, protected, or private.

Example

The following example shows a simple <apiQualifier> element for a Visual Basic property.

<apiValue id="parameter">
   <apiName>theNameOPT</apiName>
   <apiValueDetail>
      <apiValueDef>
         <apiQualifier name="access" value="public"/>
         <apiValueClassifier href="string.html" type="html">String</apiValueClassifier>
          <apiDefNote>A string that provides the name to assign to the action. Providing a valid
             value for this parameter is optional. If you do not want to provide a value,
             use the empty string ("").</apiDefNote>
      </apiValueDef>
    </apiValueDetail>
</apiValue>

Contained by

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

Content model

no content

Inheritance

topic/state reference/state