include/zephyr: Add 'version' and 'since' tag to groups

Based on information from doc/develop/api/overview.rst, add current
version for some groups representing APIs, following the following
table:

  - Experimental:   0.1.0
  - Unstable:       0.8.0
  - Stable:         1.0.0

Also based on doc/develop/api/overview.rst, add 'since' tag to the
groups.

Signed-off-by: Ederson de Souza <ederson.desouza@intel.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Ederson de Souza 2023-08-25 15:24:48 -07:00 committed by Carles Cufí
parent 9d9d1ff380
commit 28d08ada28
88 changed files with 180 additions and 0 deletions

View File

@ -68,6 +68,8 @@
@brief Modem APIs
@defgroup modem Modem APIs
@since 3.5
@version 0.1.0
@{
@}

View File

@ -18,6 +18,8 @@
* @brief Abstraction for audio codecs
*
* @defgroup audio_codec_interface Audio Codec Interface
* @since 1.13
* @version 0.1.0
* @ingroup audio_interface
* @{
*/

View File

@ -28,6 +28,8 @@
* @brief Abstraction for digital microphones
*
* @defgroup audio_dmic_interface Digital Microphone Interface
* @since 1.13
* @version 0.1.0
* @ingroup audio_interface
* @{
*/

View File

@ -34,6 +34,8 @@ extern "C" {
/**
* @brief Generic Access Profile (GAP)
* @defgroup bt_gap Generic Access Profile (GAP)
* @since 1.0
* @version 1.0.0
* @ingroup bluetooth
* @{
*/

View File

@ -27,6 +27,8 @@
/**
* @brief Crypto APIs
* @defgroup crypto Crypto
* @since 1.7
* @version 1.0.0
* @ingroup os_services
* @{
*/

View File

@ -24,6 +24,8 @@ extern "C" {
/**
* @brief Device Model
* @defgroup device_model Device Model
* @since 1.0
* @version 1.0.0
* @{
*/

View File

@ -28,6 +28,8 @@
/**
* @brief devicetree.h API
* @defgroup devicetree Devicetree
* @since 2.2
* @version 1.0.0
* @{
* @}
*/

View File

@ -24,6 +24,8 @@ extern "C" {
/**
* @brief ADC driver APIs
* @defgroup adc_interface ADC driver APIs
* @since 1.0
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -15,6 +15,8 @@
/**
* @brief Auxiliary (Text) Display Interface
* @defgroup auxdisplay_interface Text Display Interface
* @since 3.4
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -30,6 +30,8 @@ extern "C" {
/**
* @brief CAN Interface
* @defgroup can_interface CAN Interface
* @since 1.12
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -17,6 +17,8 @@ extern "C" {
/**
* @brief CAN Transceiver Driver APIs
* @defgroup can_transceiver CAN Transceiver
* @since 3.1
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -17,6 +17,8 @@
/**
* @brief Clock Control Interface
* @defgroup clock_control_interface Clock Control Interface
* @since 1.0
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -16,6 +16,8 @@
/**
* @brief Counter Interface
* @defgroup counter_interface Counter Interface
* @since 1.14
* @version 0.8.0
* @ingroup io_interfaces
* @{
*/

View File

@ -21,6 +21,8 @@ extern "C" {
/**
* @brief DAC driver APIs
* @defgroup dac_interface DAC driver APIs
* @since 2.3
* @version 0.8.0
* @ingroup io_interfaces
* @{
*/

View File

@ -14,6 +14,8 @@
/**
* @defgroup dai_interface DAI Interface
* @since 3.1
* @version 0.1.0
* @ingroup io_interfaces
* @brief DAI Interface
*

View File

@ -21,6 +21,8 @@
/**
* @brief Disk Driver Interface
* @defgroup disk_driver_interface Disk Driver Interface
* @since 1.6
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -15,6 +15,8 @@
/**
* @brief Display Interface
* @defgroup display_interface Display Interface
* @since 1.14
* @version 0.8.0
* @ingroup io_interfaces
* @{
*/

View File

@ -24,6 +24,8 @@ extern "C" {
/**
* @brief DMA Interface
* @defgroup dma_interface DMA Interface
* @since 1.5
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -18,6 +18,8 @@
/**
* @defgroup edac EDAC API
* @since 2.5
* @version 0.8.0
* @ingroup io_interfaces
* @{
*/

View File

@ -19,6 +19,8 @@
/**
* @brief EEPROM Interface
* @defgroup eeprom_interface EEPROM Interface
* @since 2.1
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -16,6 +16,8 @@
/**
* @brief Entropy Interface
* @defgroup entropy_interface Entropy Interface
* @since 1.10
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -45,6 +45,8 @@ struct flash_pages_layout {
/**
* @brief FLASH Interface
* @defgroup flash_interface FLASH Interface
* @since 1.2
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -11,6 +11,8 @@
/**
* @brief Fuel Gauge Interface
* @defgroup fuel_gauge_interface Fuel Gauge Interface
* @since 3.3
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -15,6 +15,8 @@
/**
* @brief GNSS Interface
* @defgroup gnss_interface GNSS Interface
* @since 3.6
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -32,6 +32,8 @@ extern "C" {
/**
* @brief GPIO Driver APIs
* @defgroup gpio_interface GPIO Driver APIs
* @since 1.0
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -16,6 +16,8 @@
/**
* @brief Hardware Information Interface
* @defgroup hwinfo_interface Hardware Info Interface
* @since 1.14
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -15,6 +15,8 @@
/**
* @brief I2C Interface
* @defgroup i2c_interface I2C Interface
* @since 1.0
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -15,6 +15,8 @@
/**
* @brief I2C EEPROM Target Driver API
* @defgroup i2c_eeprom_target_api I2C EEPROM Target Driver API
* @since 1.13
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -14,6 +14,8 @@
/**
* @defgroup i2s_interface I2S Interface
* @since 1.9
* @version 1.0.0
* @ingroup io_interfaces
* @brief I2S (Inter-IC Sound) Interface
*

View File

@ -11,6 +11,8 @@
/**
* @brief I3C Interface
* @defgroup i3c_interface I3C Interface
* @since 3.2
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -16,6 +16,8 @@
/**
* @brief IPM Interface
* @defgroup ipm_interface IPM Interface
* @since 1.0
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -28,6 +28,8 @@ extern "C" {
/**
* @brief KSCAN APIs
* @defgroup kscan_interface Keyboard Scan Driver APIs
* @since 2.1
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -15,6 +15,8 @@
/**
* @brief LED Interface
* @defgroup led_interface LED Interface
* @since 1.12
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -15,6 +15,8 @@
* @file
* @brief Public LoRa APIs
* @defgroup lora_api LoRa APIs
* @since 2.2
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -20,6 +20,8 @@ extern "C" {
/**
* @brief MBOX Interface
* @defgroup mbox_interface MBOX Interface
* @since 1.0
* @version 0.1.0
* @ingroup io_interfaces
* @{
*

View File

@ -24,6 +24,8 @@
/**
* @brief MIPI-DBI driver APIs
* @defgroup mipi_dbi_interface MIPI-DBI driver APIs
* @since 3.6
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -15,6 +15,8 @@
/**
* @brief MIPI-DSI driver APIs
* @defgroup mipi_dsi_interface MIPI-DSI driver APIs
* @since 3.1
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -14,6 +14,8 @@
/**
* @brief Time-aware GPIO Interface
* @defgroup tgpio_interface Time-aware GPIO Interface
* @since 3.5
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -15,6 +15,8 @@
/**
* @brief PECI Interface 3.0
* @defgroup peci_interface PECI Interface
* @since 2.1
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -14,6 +14,8 @@
/**
* @brief Pin Controller Interface
* @defgroup pinctrl_interface Pin Controller Interface
* @since 3.0
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -16,6 +16,8 @@
/**
* @brief PWM Interface
* @defgroup pwm_interface PWM Interface
* @since 1.0
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -13,6 +13,8 @@
/**
* @brief Regulator Interface
* @defgroup regulator_interface Regulator Interface
* @since 2.4
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -15,6 +15,8 @@
/**
* @brief Reset Controller Interface
* @defgroup reset_controller_interface Reset Controller Interface
* @since 3.1
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -30,6 +30,8 @@ BUILD_ASSERT(!(sizeof(off_t) > sizeof(size_t)),
/**
* @brief Retained memory driver interface
* @defgroup retained_mem_interface Retained memory driver interface
* @since 3.4
* @version 0.8.0
* @ingroup io_interfaces
* @{
*/

View File

@ -16,6 +16,8 @@
/**
* @brief RTC Interface
* @defgroup rtc_interface RTC Interface
* @since 3.4
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -19,6 +19,8 @@
/**
* @brief SDHC interface
* @defgroup sdhc_interface SDHC interface
* @since 3.1
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -15,6 +15,8 @@
/**
* @brief Sensor Interface
* @defgroup sensor_interface Sensor Interface
* @since 1.2
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -15,6 +15,8 @@
/**
* @brief SMBus Interface
* @defgroup smbus_interface SMBus Interface
* @since 3.4
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -15,6 +15,8 @@
/**
* @brief SPI Interface
* @defgroup spi_interface SPI Interface
* @since 1.0
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -16,6 +16,8 @@
/**
* @brief UART Interface
* @defgroup uart_interface UART Interface
* @since 1.0
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/
@ -150,6 +152,8 @@ typedef void (*uart_irq_config_func_t)(const struct device *dev);
* @}
*
* @defgroup uart_async Async UART API
* @since 1.14
* @version 0.8.0
* @{
*/

View File

@ -18,6 +18,8 @@
/**
* @brief USB Type-C Port Controller API
* @defgroup usb_type_c_port_controller_api USB Type-C Port Controller API
* @since 3.1
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -18,6 +18,8 @@
/**
* @brief USB-C VBUS API
* @defgroup usbc_vbus_api USB-C VBUS API
* @since 3.3
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -15,6 +15,8 @@
/**
* @brief Video Interface
* @defgroup video_interface Video Interface
* @since 2.1
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -26,6 +26,8 @@ extern "C" {
/**
* @brief 1-Wire Interface
* @defgroup w1_interface 1-Wire Interface
* @since 3.2
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -11,6 +11,8 @@
/**
* @brief Watchdog Interface
* @defgroup watchdog_interface Watchdog Interface
* @since 1.0
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/

View File

@ -32,6 +32,8 @@
/**
* @brief DSP Interface
* @defgroup math_dsp DSP Interface
* @since 3.3
* @version 0.1.0
*/
#include <zephyr/dsp/types.h>

View File

@ -24,6 +24,8 @@ extern "C" {
/**
* @defgroup fcb Flash Circular Buffer (FCB)
* @since 1.11
* @version 1.0.0
* @ingroup file_system_storage
* @{
* @}

View File

@ -20,6 +20,8 @@ extern "C" {
/**
* @brief File System APIs
* @defgroup file_system_api File System APIs
* @since 1.5
* @version 1.0.0
* @ingroup os_services
* @{
*/

View File

@ -19,6 +19,8 @@ extern "C" {
/**
* @brief Non-volatile Storage (NVS)
* @defgroup nvs Non-volatile Storage (NVS)
* @since 1.12
* @version 1.0.0
* @ingroup file_system_storage
* @{
* @}

View File

@ -10,6 +10,8 @@
/**
* @brief Input Interface
* @defgroup input_interface Input Interface
* @since 3.4
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -38,6 +38,8 @@ BUILD_ASSERT(sizeof(intptr_t) == sizeof(long));
/**
* @brief Kernel APIs
* @defgroup kernel_apis Kernel APIs
* @since 1.0
* @version 1.0.0
* @{
* @}
*/

View File

@ -21,6 +21,8 @@ extern "C" {
/**
* @brief Linkable loadable extensions
* @defgroup llext Linkable loadable extensions
* @since 3.5
* @version 0.1.0
* @ingroup os_services
* @{
*/

View File

@ -18,6 +18,8 @@ extern "C" {
/**
* @brief Logging
* @defgroup logging Logging
* @since 1.13
* @version 1.0.0
* @ingroup os_services
* @{
* @}

View File

@ -18,6 +18,7 @@ extern "C" {
/**
* @brief Logger
* @defgroup logger Logger system
* @since 1.13
* @ingroup logging
* @{
* @}
@ -26,6 +27,7 @@ extern "C" {
/**
* @brief Logger control API
* @defgroup log_ctrl Logger control API
* @since 1.13
* @ingroup logger
* @{
*/

View File

@ -11,6 +11,8 @@
* @file
* @brief Public LoRaWAN APIs
* @defgroup lorawan_api LoRaWAN APIs
* @since 2.5
* @version 0.1.0
* @ingroup connectivity
* @{
*/

View File

@ -10,6 +10,8 @@
/**
* @brief EC Host Command Interface
* @defgroup ec_host_cmd_interface EC Host Command Interface
* @since 2.4
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/

View File

@ -20,6 +20,8 @@ extern "C" {
/**
* @brief MCUmgr mgmt API
* @defgroup mcumgr_mgmt_api MCUmgr mgmt API
* @since 1.11
* @version 1.0.0
* @ingroup mcumgr
* @{
*/

View File

@ -17,6 +17,8 @@
/**
* @brief COAP library
* @defgroup coap COAP Library
* @since 1.10
* @version 0.8.0
* @ingroup networking
* @{
*/

View File

@ -25,6 +25,8 @@ extern "C" {
/**
* @brief Connection Manager Connectivity API
* @defgroup conn_mgr_connectivity Connection Manager Connectivity API
* @since 3.4
* @version 0.1.0
* @ingroup networking
* @{
*/

View File

@ -26,6 +26,8 @@ extern "C" {
/**
* @defgroup ieee802154 IEEE 802.15.4 and Thread APIs
* @since 1.0
* @version 0.8.0
* @ingroup connectivity
*
* @brief IEEE 802.15.4 native and OpenThread L2, configuration, management and
@ -76,6 +78,8 @@ extern "C" {
/**
* @defgroup ieee802154_l2 IEEE 802.15.4 L2
* @since 1.0
* @version 0.8.0
* @ingroup ieee802154
*
* @brief IEEE 802.15.4 L2 APIs

View File

@ -23,6 +23,8 @@ extern "C" {
/**
* @defgroup ieee802154_mgmt IEEE 802.15.4 Net Management
* @since 1.0
* @version 0.8.0
* @ingroup ieee802154
*
* @brief IEEE 802.15.4 net management library

View File

@ -29,6 +29,8 @@ extern "C" {
/**
* @defgroup ieee802154_driver IEEE 802.15.4 Drivers
* @since 1.0
* @version 0.8.0
* @ingroup ieee802154
*
* @brief IEEE 802.15.4 driver API

View File

@ -8,6 +8,8 @@
/** @file lwm2m.h
*
* @defgroup lwm2m_api LwM2M high-level API
* @since 1.9
* @version 0.8.0
* @ingroup networking
* @{
* @brief LwM2M high-level API

View File

@ -7,6 +7,8 @@
/** @file mqtt.h
*
* @defgroup mqtt_socket MQTT Client library
* @since 1.14
* @version 0.8.0
* @ingroup networking
* @{
* @brief MQTT Client Implementation

View File

@ -29,6 +29,8 @@ extern "C" {
/**
* @brief Networking
* @defgroup networking Networking
* @since 1.0
* @version 1.0.0
* @ingroup connectivity
* @{
* @}

View File

@ -21,6 +21,7 @@ extern "C" {
/**
* @brief System and device power management
* @defgroup subsys_pm Power Management (PM)
* @since 1.2
* @ingroup os_services
* @{
* @}
@ -29,6 +30,7 @@ extern "C" {
/**
* @brief System Power Management API
* @defgroup subsys_pm_sys System
* @since 1.2
* @ingroup subsys_pm
* @{
*/

View File

@ -28,6 +28,8 @@
/**
* @brief Random Function APIs
* @defgroup random_api Random Function APIs
* @since 1.0
* @version 1.0.0
* @ingroup crypto
* @{
*/

View File

@ -27,6 +27,8 @@ extern "C" {
/**
* @brief Bootloader info interface
* @defgroup bootloader_info_interface Bootloader info interface
* @since 3.5
* @version 0.1.0
* @ingroup retention_api
* @{
*/

View File

@ -26,6 +26,8 @@ extern "C" {
/**
* @brief Retention API
* @defgroup retention_api Retention API
* @since 3.4
* @version 0.1.0
* @ingroup os_services
* @{
*/

View File

@ -46,6 +46,8 @@ extern "C" {
/**
* @brief RTIO
* @defgroup rtio RTIO
* @since 3.2
* @version 0.1.0
* @ingroup os_services
* @{
*/

View File

@ -28,6 +28,8 @@ extern "C" {
/**
* @defgroup settings Settings
* @since 1.12
* @version 1.0.0
* @ingroup file_system_storage
* @{
*/

View File

@ -69,6 +69,8 @@ extern "C" {
/**
* @brief Shell API
* @defgroup shell_api Shell API
* @since 1.14
* @version 1.0.0
* @ingroup os_services
* @{
*/

View File

@ -18,6 +18,8 @@
* @brief Abstraction over flash partitions/areas and their drivers
*
* @defgroup flash_area_api flash area Interface
* @since 1.11
* @version 1.0.0
* @ingroup storage_apis
* @{
*/

View File

@ -17,6 +17,8 @@
* @brief Abstraction over stream writes to flash
*
* @defgroup stream_flash Stream to flash interface
* @since 2.3
* @version 0.1.0
* @ingroup storage_apis
* @{
*/

View File

@ -25,6 +25,8 @@ extern "C" {
/**
* @addtogroup barrier_apis Barrier Services APIs
* @since 3.4
* @version 0.1.0
* @ingroup kernel_apis
* @{
*/

View File

@ -38,6 +38,8 @@ extern "C" {
/**
* @defgroup sys-util Utility Functions
* @since 2.4
* @version 0.1.0
* @ingroup utilities
* @{
*/

View File

@ -24,6 +24,8 @@
/**
* @brief Task Watchdog APIs
* @defgroup task_wdt_api Task Watchdog APIs
* @since 2.5
* @version 0.8.0
* @ingroup os_services
* @{
*/

View File

@ -25,6 +25,8 @@ extern "C" {
/**
* @brief USB-C Device APIs
* @defgroup _usbc_device_api USB-C Device API
* @since 3.3
* @version 0.1.0
* @{
*/