apiOperation

The <apiOperation> element specifies a collection of features, such as attributes, methods, values, and operations.

Description

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

Contained by

apiClassifier, apiOperation, apiPackage, apiValue

Contains

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

Content model

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

Inheritance

topic/topic reference/reference apiRef/apiRef