javaPackage

The <javaPackage> element provides the name of the Java API package and all the elements necessary to describe the package, or set of packages, and its components.

Description

The <javaPackage> element requires an ID attribute as an anchor point. This ID is the target for references by <link> or <xref> elements (conref attribute), and for other internal specialization elements that refer to this content. Use a unique key such as fully qualified package name for the named API reference. The <apiName>, <shortdesc>, <javaPackageDetail>, and <apiDesc> elements are required for this top-level container.

Contains

apiName, apiSyntax, javaPackageDetail, no-topic-nesting, prolog, related-links, shortdesc

Content model

( (apiSyntax) (optional) then (apiName) then (shortdesc) then (prolog) (optional) then (javaPackageDetail) then (related-links) (optional) then (no-topic-nesting) (any number))

Inheritance

topic/topic reference/reference apiRef/apiRef apiPackage/apiPackage