apiClassifier

The <apiClassifier> element specifies a classifier and comes in several specific forms, including class, data type, interface, component, and other API references.

Description

The <apiClassifier> 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 <apiClassifier> content. Use a unique key such as fully qualified package name for the named API reference.

Contained by

apiClassifier, apiOperation, apiPackage

Contains

apiClassifier, apiClassifierDetail, apiName, apiOperation, apiValue, prolog, related-links, shortdesc

Content model

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

Inheritance

topic/topic reference/reference apiRef/apiRef