Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: remove unsupported doxygen directive attributes #1465

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: remove unsupported doxygen directive attributes #1465

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 0 additions & 118 deletions crypto/doc/api.rst
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 0 additions & 6 deletions gzll/doc/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,13 @@ API documentation
:depth: 2

.. doxygengroup:: gzll_api
:project: nrfxlib
:members:

Constants
*********

.. doxygengroup:: gzll_constants
:project: nrfxlib
:members:

Glue layer
**********

.. doxygengroup:: gzll_glue
:project: nrfxlib
:members:
4 changes: 0 additions & 4 deletions lc3/doc/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,10 @@ Translation layer API documentation
| Source file: :file:`lc3/src/sw_codec_lc3.c`

.. doxygengroup:: LC3_translation
:project: nrfxlib
:members:

LC3 API documentation
*********************

| Header file: :file:`codec/inc/LC3API.h`

.. doxygengroup:: LC3
:project: nrfxlib
:members:
28 changes: 0 additions & 28 deletions mpsl/doc/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,122 +11,94 @@ Multiprotocol Service Layer interface
*************************************

.. doxygengroup:: mpsl
:project: nrfxlib
:members:

.. _mpsl_api_clk:

MPSL Clock
**********

.. doxygengroup:: mpsl_clock
:project: nrfxlib
:members:

.. _mpsl_api_timeslot:

MPSL Timeslot
*************

.. doxygengroup:: mpsl_timeslot
:project: nrfxlib
:members:

.. _mpsl_api_rn:

MPSL TX Power
*************

.. doxygengroup:: mpsl_tx_power
:project: nrfxlib
:members:

.. _mpsl_api_fem:

MPSL FEM
********

.. doxygengroup:: mpsl_fem
:project: nrfxlib
:members:

.. _mpsl_api_fem_common:

MPSL FEM common configuration
*****************************

.. doxygengroup:: mpsl_fem_config_common
:project: nrfxlib
:members:

.. _mpsl_api_fem_21540_config:

MPSL FEM common nRF21540 configuration
**************************************

.. doxygengroup:: mpsl_fem_nrf21540_common
:project: nrfxlib
:members:

.. _mpsl_api_fem_21540_gpio:

MPSL FEM nRF21540 GPIO
**********************

.. doxygengroup:: mpsl_fem_nrf21540_gpio
:project: nrfxlib
:members:

.. _mpsl_api_fem_21540_gpiospi:

MPSL FEM nRF21540 GPIO/SPI
**************************

.. doxygengroup:: mpsl_fem_nrf21540_gpio_spi
:project: nrfxlib
:members:

.. _mpsl_api_fem_simple:

MPSL FEM Simple GPIO
********************

.. doxygengroup:: mpsl_fem_simple_gpio
:project: nrfxlib
:members:

.. _mpsl_api_fem_power:

MPSL FEM power model
********************

.. doxygengroup:: mpsl_fem_power_model
:project: nrfxlib
:members:

.. _mpsl_api_sr_cx:

MPSL CX (Coexistence)
*********************

.. doxygengroup:: mpsl_cx
:project: nrfxlib
:members:

.. _mpsl_api_temp:

MPSL Temp
*********

.. doxygengroup:: mpsl_temp
:project: nrfxlib
:members:

.. _mpsl_api_dppi:

MPSL DPPI Protocol
******************

.. doxygengroup:: mpsl_dppi_protocol_api
:project: nrfxlib
:members:
2 changes: 0 additions & 2 deletions nfc/doc/type_2_tag.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,5 +398,3 @@ API documentation
*****************

.. doxygengroup:: nfc_t2t_lib
:project: nrfxlib
:members:
2 changes: 0 additions & 2 deletions nfc/doc/type_4_tag.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,5 +71,3 @@ API documentation
*****************

.. doxygengroup:: nfc_t4t_lib
:project: nrfxlib
:members:
46 changes: 0 additions & 46 deletions nrf_802154/doc/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,203 +13,157 @@ Setting addresses and PAN ID of the device
******************************************

.. doxygengroup:: nrf_802154_addresses
:project: nrfxlib
:members:

.. _radiodriver_api_data:

Functions to calculate data given by the driver
***********************************************

.. doxygengroup:: nrf_802154_data
:project: nrfxlib
:members:

.. _radiodriver_api_transitions:

Functions to request FSM transitions and check the current state
****************************************************************

.. doxygengroup:: nrf_802154_transitions
:project: nrfxlib
:members:

.. _radiodriver_api_calls:

Calls to the higher layer
*************************

.. doxygengroup:: nrf_802154_calls
:project: nrfxlib
:members:

.. _radiodriver_api_memman:

Driver memory management
************************

.. doxygengroup:: nrf_802154_memman
:project: nrfxlib
:members:

.. _radiodriver_api_rssi:

RSSI measurement function
*************************

.. doxygengroup:: nrf_802154_rssi
:project: nrfxlib
:members:

.. _radiodriver_api_prom:

Promiscuous mode
****************

.. doxygengroup:: nrf_802154_prom
:project: nrfxlib
:members:

.. _radiodriver_api_autoack:

Auto ACK management
*******************

.. doxygengroup:: nrf_802154_autoack
:project: nrfxlib
:members:

.. _radiodriver_api_cca:

CCA configuration management
****************************

.. doxygengroup:: nrf_802154_cca
:project: nrfxlib
:members:

.. _radiodriver_api_csma:

CSMA-CA procedure
*****************

.. doxygengroup:: nrf_802154_csma
:project: nrfxlib
:members:

.. _radiodriver_api_timeout:

ACK timeout procedure
*********************

.. doxygengroup:: nrf_802154_timeout
:project: nrfxlib
:members:

.. _radiodriver_api_stats:

Statistics and measurements
***************************

.. doxygengroup:: nrf_802154_stats
:project: nrfxlib
:members:

.. _radiodriver_api_ifs:

Inter-frame spacing feature
***************************

.. doxygengroup:: nrf_802154_ifs
:project: nrfxlib
:members:

.. _radiodriver_api_capabilities:

Radio driver run-time capabilities feature
******************************************

.. doxygengroup:: nrf_802154_capabilities
:project: nrfxlib
:members:

.. _radiodriver_api_security:

Radio driver MAC security feature
*********************************

.. doxygengroup:: nrf_802154_security
:project: nrfxlib
:members:

.. _radiodriver_api_ie_writer:

Radio driver Information Element data injection feature
*******************************************************

.. doxygengroup:: nrf_802154_ie_writer
:project: nrfxlib
:members:

.. _radiodriver_api_config_radio:

Radio driver configuration
**************************

.. doxygengroup:: nrf_802154_config_radio
:project: nrfxlib
:members:

.. _radiodriver_api_config_csma:

CSMA/CA procedure configuration
*******************************

.. doxygengroup:: nrf_802154_config_csma
:project: nrfxlib
:members:

.. _radiodriver_api_config_timeout:

ACK timeout feature configuration
*********************************

.. doxygengroup:: nrf_802154_config_timeout
:project: nrfxlib
:members:

.. _radiodriver_api_config_transmission:

Transmission start notification feature configuration
*****************************************************

.. doxygengroup:: nrf_802154_config_transmission
:project: nrfxlib
:members:

.. _radiodriver_api_ie:

Information Elements configuration
**********************************

.. doxygengroup:: nrf_802154_ie
:project: nrfxlib
:members:

.. _radiodriver_api_other:

Interrupt Handlers
******************

.. doxygengroup:: nrf_802154_irq
:project: nrfxlib
:members:

.. _radiodriver_api_irq:

Other functions
***************

.. doxygengroup:: nrf_802154
:project: nrfxlib
:members:
2 changes: 0 additions & 2 deletions nrf_dm/doc/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,3 @@ Distance Measurement interface
******************************

.. doxygengroup:: nrf_dm
:project: nrfxlib
:members:
2 changes: 0 additions & 2 deletions nrf_fuel_gauge/doc/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,3 @@ API documentation
| Header file: :file:`include/nrf_fuel_gauge.h`

.. doxygengroup:: nrf_fuel_gauge
:project: nrfxlib
:members:
Loading
Loading