helpAPI

API information

In the STM32Cube Expansion Package PDSC file, the <apis> section shall contain all the APIs relative to the elements in the .pack file, pointing to :

a header file using the <header> attribute, where the APIs are presented in terms of function prototypes.
a CHM file using the <doc> attribute, describing the APIs and parameters through Doxygen comments.

Class	Defines the component class to which this component belongs. This is a mandatory part of the component ID. Authorized characters : Alphanumeric, "-", "_", " " (blank). Min 2 characters, Max 32 characters Leading or trailing spaces forbidden
Group	Defines the component group to which this component belongs. This is a mandatory part of the component ID. Authorized characters : Alphanumeric, "-", "_", " " (blank). Min 2 characters, Max 32 characters Leading or trailing spaces forbidden
Version	Version of this component. Is a mandatory part of the component ID. Format version is MAJOR.MINOR.PATCH[-Pre Release][+Build Metadata]
Description	Brief summary about the purpose and scope of an API.
Condition	Enter the identifier (attribute id) of a condition. The element is used if the condition resolves to true. If the condition resolves to false, then the element will be ignored. For example, an API might be specific for a certain toolchain or processor instruction set.
Exclusive	Makes the selection of a component implementing the API exclusive. If set to 0, then multiple components implementing the API can be selected. Default is 1.