Defines a top-level container for the general-purpose topic types for a library, package, header, module, namespace, class members, or other named grouping for the entities provided by the API.
Within an apiPackage topic type, you can create a New Document Type by clicking
from the Epic Editor Menu for creating and publishing API package documentation.To represent multiple values for the <apiPackage> element , create additional <apiPackage> elements for each successive value. Use <apiPackage> element in conjunction with apiMap module to displays the short descriptions for all component classes/interfaces, methods/properties, namespace, etc.
The following example shows a simple <apiPackage> element for a VB.NET package:
<apiPackage id="rational.xde"> <apiName>RXE.NET API Reference</apiName> <shortdesc>Rational XDE includes Rational XDE Extensibility (RXE), an application programming interface (API) and related examples and tools that allow users to customize and extend XDE.</shortdesc> </apiPackage>
The following example shows a simple <apiPackage> element for a VB public class:
<apiPackage id="IRXEAssociationPM"> <apiName>IRXEAssociation Properties and Methods</apiName> <shortdesc>The following objects are available to RXE .NET users for use within their scripts.</shortdesc> <apiDetail> <apiDesc>The Public Members are grouped by category and then listed alphabetically.</apiDesc> <apiDetail> <related-links> <link keyref=”IRXEAssociation.dita”> <linktext>IRXEAssociation Interface</linktext> </link> </related-links> </apiPackage>