Skip to content

Commit

Permalink
include/zephyr: Add 'version' and 'since' tag to groups
Browse files Browse the repository at this point in the history
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 <[email protected]>
Signed-off-by: Anas Nashif <[email protected]>
  • Loading branch information
edersondisouza authored and carlescufi committed Mar 19, 2024
1 parent 9d9d1ff commit 28d08ad
Show file tree
Hide file tree
Showing 88 changed files with 180 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/_doxygen/groups.dox
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@

@brief Modem APIs
@defgroup modem Modem APIs
@since 3.5
@version 0.1.0
@{
@}

Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/audio/codec.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/audio/dmic.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/bluetooth/bluetooth.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/crypto/crypto.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
/**
* @brief Crypto APIs
* @defgroup crypto Crypto
* @since 1.7
* @version 1.0.0
* @ingroup os_services
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/device.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ extern "C" {
/**
* @brief Device Model
* @defgroup device_model Device Model
* @since 1.0
* @version 1.0.0
* @{
*/

Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/devicetree.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
/**
* @brief devicetree.h API
* @defgroup devicetree Devicetree
* @since 2.2
* @version 1.0.0
* @{
* @}
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/adc.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/auxdisplay.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/can.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ extern "C" {
/**
* @brief CAN Interface
* @defgroup can_interface CAN Interface
* @since 1.12
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/can/transceiver.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/clock_control.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/counter.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
/**
* @brief Counter Interface
* @defgroup counter_interface Counter Interface
* @since 1.14
* @version 0.8.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/dac.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/dai.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

/**
* @defgroup dai_interface DAI Interface
* @since 3.1
* @version 0.1.0
* @ingroup io_interfaces
* @brief DAI Interface
*
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/disk.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/display.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
/**
* @brief Display Interface
* @defgroup display_interface Display Interface
* @since 1.14
* @version 0.8.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/dma.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ extern "C" {
/**
* @brief DMA Interface
* @defgroup dma_interface DMA Interface
* @since 1.5
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/edac.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

/**
* @defgroup edac EDAC API
* @since 2.5
* @version 0.8.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/eeprom.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
/**
* @brief EEPROM Interface
* @defgroup eeprom_interface EEPROM Interface
* @since 2.1
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/entropy.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
/**
* @brief Entropy Interface
* @defgroup entropy_interface Entropy Interface
* @since 1.10
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/flash.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/fuel_gauge.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/gnss.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
/**
* @brief GNSS Interface
* @defgroup gnss_interface GNSS Interface
* @since 3.6
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/gpio.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/hwinfo.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
/**
* @brief Hardware Information Interface
* @defgroup hwinfo_interface Hardware Info Interface
* @since 1.14
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/i2c.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
/**
* @brief I2C Interface
* @defgroup i2c_interface I2C Interface
* @since 1.0
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/i2c/target/eeprom.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/i2s.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/i3c.h
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
/**
* @brief I3C Interface
* @defgroup i3c_interface I3C Interface
* @since 3.2
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/ipm.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
/**
* @brief IPM Interface
* @defgroup ipm_interface IPM Interface
* @since 1.0
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/kscan.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/led.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
/**
* @brief LED Interface
* @defgroup led_interface LED Interface
* @since 1.12
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/lora.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
* @file
* @brief Public LoRa APIs
* @defgroup lora_api LoRa APIs
* @since 2.2
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/mbox.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ extern "C" {
/**
* @brief MBOX Interface
* @defgroup mbox_interface MBOX Interface
* @since 1.0
* @version 0.1.0
* @ingroup io_interfaces
* @{
*
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/mipi_dbi.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/mipi_dsi.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/misc/timeaware_gpio/timeaware_gpio.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/peci.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
/**
* @brief PECI Interface 3.0
* @defgroup peci_interface PECI Interface
* @since 2.1
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/pinctrl.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
/**
* @brief Pin Controller Interface
* @defgroup pinctrl_interface Pin Controller Interface
* @since 3.0
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/pwm.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
/**
* @brief PWM Interface
* @defgroup pwm_interface PWM Interface
* @since 1.0
* @version 1.0.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/regulator.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
/**
* @brief Regulator Interface
* @defgroup regulator_interface Regulator Interface
* @since 2.4
* @version 0.1.0
* @ingroup io_interfaces
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/reset.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/drivers/retained_mem.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/
Expand Down
Loading

0 comments on commit 28d08ad

Please sign in to comment.