Description: The <apiValue> element specifies a collection futures, such as constants, variables, enumerations, structures, or other named values.

# apiValue

The <apiValue> element specifies a collection futures, such as constants, variables, enumerations, structures, or other named values.

#### Description

This element requires an ID attribute as an anchor point. This ID is the target for references by <link> , <xref>, or other internal specialization type elements that refer to the <apiRef> element content (conref and keyref attributes). Use a unique key such as fully qualified classifier name for the named API reference. For instance, the full name of a method contains the method name that is qualified by the name of the class that provides the method and by the name of the package that, in turn, provides the class. You provide the name in the API reference topic. The fully qualified name is generated based on the API items that contain this item.

#### Contained by

apiClassifier, apiOperation, apiPackage, apiValue

#### Contains

apiName, apiOperation, apiValue, apiValueDetail, prolog, related-links, shortdesc

#### Content model

( (apiName) then (shortdesc) then (prolog) (optional) then (apiValueDetail) then (related-links) (optional) then (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).
- apiValueDetail
  The <apiValueDetail> element provides the detailed information about the access to the value.
- 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: apiValue module