apiValue module

Defines a subordinate container to the <apiOperation> element for generic topic types such as constants, variables, enumerations, structures, or other named values.

Description

The named values can be nested as part of a classifier or package interface.

Example

The following example shows a simple <apiValue> element for Visual Basic parameters:

<apiOperation id=”com.ibm.xtools”>
<apiValue id="startWriteAction">
   <apiName>theNameOPT</apiName>
   <apiValueDetail>
      <apiValueDef>
         <apiQualifier name="type" value="string"/>
          <apiValueClassifier href="../string.html" type="html" scope="local">
              String
          </apiValueClassifier>
          <apiDefNote>A string that provides the name to assign to the action. 
             Providing a valid value for this parameter is optional.
           </apiDefNote>
      </apiValueDef>
    </apiValueDetail>
</apiValue>
<apiValue id="startWriteAction">
   <apiName>delimiterOPT</apiName>
   <apiValueDetail>
      <apiValueDef>
         <apiQualifier name="parameter" value="delimiterOPT"/>
          <apiValueClassifier
              href="../string.html" type="html" scope="local">
              String
          </apiValueClassifier>
          <apiDefNote>
             A string that provides the text that you want to use to separate the stereotype
             names. Providing a valid value for this parameter is optional.
           </apiDefNote>
      </apiValueDef>
    </apiValueDetail>
</apiValue>
</apiOperation>