Skip to content

Add support for multiple Doxygen projects, add wifi bridge #19341

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

Merged
merged 4 commits into from
Feb 17, 2025
Merged

Add support for multiple Doxygen projects, add wifi bridge #19341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aa7e241
doc: nrf: add bridge for wifi Doxygen
gmarull Dec 9, 2024
858a9de
doc: nrf: add wifi low-level API docs
gmarull Dec 9, 2024
9e785cf
doc: zoomin: add wifi doxygen docset
gmarull Dec 9, 2024
0701b89
doc: nrf: add zephyr to doxybridge projects
gmarull Dec 11, 2024
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
2 changes: 1 addition & 1 deletion .github/workflows/docbuild.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ jobs:
done

# Doxygen APIs standalone
declare -a DOXYGEN=("nrfx")
declare -a DOXYGEN=("nrfx" "wifi")

for docset in "${DOXYGEN[@]}"; do
OUTDIR=doc/_build/html-doxygen/$docset-apis
Expand Down
2 changes: 1 addition & 1 deletion doc/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ endfunction()
add_dependencies(nrfxlib-inventory-all kconfig-all zephyr-all)
add_doc_dependencies(zephyr kconfig-all)
add_doc_dependencies(mcuboot kconfig-all)
add_doc_dependencies(nrf zephyr-all nrfxlib-inventory-all mcuboot-all matter-all tfm-all kconfig-all)
add_doc_dependencies(nrf zephyr-all nrfxlib-inventory-all mcuboot-all matter-all tfm-all kconfig-all wifi)
add_doc_dependencies(nrfxlib nrf-all)

add_custom_target(build-all ALL)
Expand Down
2 changes: 2 additions & 0 deletions doc/_zoomin/wifi.apis.custom.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
manual.name=wifi-apis-__VERSION__
booktitle=Wi-Fi APIs - __VERSION__
10 changes: 10 additions & 0 deletions doc/_zoomin/wifi.apis.tags.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Document tags for Zoomin.

# Tags for all topics:
mapping_global:
- wifi-apis
- wifi-apis-__VERSION__
- cluster-wifi-apis-__VERSION__

# Tags for individual topics:
mapping_topics: []
6 changes: 5 additions & 1 deletion doc/nrf/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,11 @@

# -- Options for doxybridge plugin ---------------------------------------------

doxybridge_projects = {"nrf": _doxyrunner_outdir}
doxybridge_projects = {
"nrf": _doxyrunner_outdir,
"wifi": utils.get_builddir() / "html" / "wifi",
"zephyr": utils.get_builddir() / "html" / "zephyr" / "doxygen",
}

# Options for ncs_include ------------------------------------------------------

Expand Down
1 change: 1 addition & 0 deletions doc/nrf/drivers/wifi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ Wi-Fi drivers

wifi/nrf70_native
wifi/nrf70_portable
wifi/low_level_api
40 changes: 40 additions & 0 deletions doc/nrf/drivers/wifi/low_level_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
Low-Level API
#############

Common
******

The common API is used for both normal operation and Radio Test mode.

| Header file: :file:`nrf_wifi/fw_if/umac_if/inc/fmac_structs_common.h`
| Source file: :file:`nrf_wifi/fw_if/umac_if/src/fmac_api_common.c`


.. doxygengroup:: nrf_wifi_api_common
:project: wifi

Radio Test mode
***************

The Radio Test mode is used for testing the RF performance of the nRF70 Series device, mainly to characterize the RF.

.. note::

Documentation for data structure definitions is disabled for this module.
It will be enabled in the future.

| Source file: :file:`nrf_wifi/fw_if/umac_if/src/radio_test/fmac_api.c`

.. doxygengroup:: nrf_wifi_api_radio_test
:project: wifi

Wi-Fi mode
**********

The Wi-Fi mode is used for the normal operation of the nRF70 Series device in the :abbr:`STA (Station)` mode or other modes that will be supported in the future.

| Header file: :file:`nrf_wifi/fw_if/umac_if/inc/default/fmac_api.h`
| Source file: :file:`nrf_wifi/fw_if/umac_if/src/default/fmac_api.c`

.. doxygengroup:: nrf_wifi_api
:project: wifi