apiClassifier module

Defines a top-level container for the generic topic types such as class, interface, typedef, or other named construct for typing values.

Description

This element specifies a collection of features, such as attributes, methods, values, and operations.

In the apiClassifier topic type, you can create a New Document Type by clicking File > New from the Epic Editor menu for creating and publishing API classifier documentation.

Example

The following example shows an <apiClassifier> element used for an Visual Basic interface:

<apiClassifier id="rational.xde" outputclass="statement" platform="vb">
    <apiName>TestImplements</apiName>
    <shortdesc>Specifies one or more interfaces or interface members.</shortdesc>
    <apiClassifierDetail>
      <apiSyntax platform="vb">
        <apiSyntaxText>Implements <apiItemName>IRXEAbstraction</apiItemName> 
                          <apiItemName>TestImplements</apiItemName>[name, …]<apiRelation
        </apiSyntaxText>
        <apiSyntaxItem>
          <apiItemName>IRXEAbstraction</apiItemName>
          <apiDefNote>Required. An interface whose properties, methods, and events will be 
             implemented by corresponding members in the class or structure.</apiDefNote>
        </apiSyntaxItem>
        <apiSyntaxItem>
         <apiItemName>TestImplements</apiItemName>
           <apiDefNote>Required. The member of an interface that is being implemented.</apiDefNote>
        </apiSyntaxItem>
        <apiSyntaxItem id="nameParam">
           <apiItemName>name</apiItemName>
              <apiDefNote>The name for the created interface member.</apiDefNote>
        </apiSyntaxItem>
     </apiSyntax>
     <apiDesc>An interface is a collection of prototypes representing the members 
         (properties, methods and events) the interface encapsulates.</apiDesc>
</apiClassifier>