description

Required: Yes
Type: String
Condition: No

Textual description of the component, meant to provide an end user with information about its functionality. Used for search and in user interfaces. The description is typically not more than a few sentences, as full component documentation can be registered using the documentation key.

Other components can be referenced in the description text by enclosing the ID of the component in angle brackets. GUI tools should render this as a clickable link using the component label as the link text. Pairs of angle brackets whose content does not match any component shall be left as-is.

description: >
  SPI master driver with DMA support. Uses the USART peripheral in 
  synchronous mode, and automatically allocates a DMA channel using
  the <dmadrv> component.