Description: The <apiPackage> element provides the name of the API package, module, public class members, namespace and all the elements that are necessary to describe its components.

# apiPackage

The <apiPackage> element provides the name of the API package, module, public class members, namespace and all the elements that are necessary to describe its components.

#### Description

The <apiPackage> contain a list of items with first sentence summaries for this API items.

The <apiPackage> element requires an ID attribute as an anchor point. This ID is the target for references by <link> or <xref> elements (conref and keyref attributes), and for other internal specialization elements that refer to this <apiPackage> content. Use a unique key such as fully qualified package name for the named API reference.

#### Contained by

apiPackage

#### Contains

apiClassifier, apiDetail, apiName, apiOperation, apiPackage, apiValue, prolog, related-links, shortdesc

#### Content model

( (apiName) then (shortdesc) then (prolog) (optional) then (apiDetail) then (related-links) (optional) then (apiPackage or apiClassifier or apiOperation or apiValue) (any number))

#### Inheritance

topic/topic reference/reference apiRef/apiRef

- apiName
  The <apiName> element provides the name of an application programming interface (API).
- apiDetail
  The <apiDetail> element provides the most general representation for reference documentation detail about an API item. This element is the main container for the detailed content.
- apiClassifier module
  Defines a top-level container for the generic topic types such as class, interface, typedef, or other named construct for typing values.
- apiOperation module
  Defines a top-level container for general-purpose topic types for a function, method, subroutine, procedure, event handler, or other named unit of executable code.
- apiValue module
  Defines a subordinate container to the <apiOperation> element for generic topic types such as constants, variables, enumerations, structures, or other named values.

Parent topic: apiPackage module