Avoid warning and properly list memory management APIs in Doxygen
documentation by actually declaring the mem_mgmt doxygen group
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
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>
Update to a more recent version of Doyxgen Awesome for better
compatibilty with recent versions of Doxygen.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Added an MFD driver for the nPM1300.
This driver has register access helper functions that can be used
by subsystems. This will avoid each subsystem having to duplicate
the register access code.
Signed-off-by: Andy Sinclair <andy.sinclair@nordicsemi.no>
Add a new top-level group for APIs that interact with third-party
services or applications. Included in the group:
- MCUboot image control API
- Hawkbit
- UpdateHub
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Add a new top-level for general utilities, like utility functions,
linear range API, time utils, etc. This category should be used by stuff
that is not strictly bound to the OS, like are OS services.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Create a USB Doxygen group, part of the top-level connectivity group.
Added some existing groups to the usb group, note that USB Doxygen needs
to be improved, though.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Add a new connectivity group and add to it the following other groups:
- LoRaWAN
- Networking
- Bluetooth
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Before this change we had 2 top-level Doxygen entries for Testing APIs:
- Zephyr tests
- Zephyr testing suite
This patch creates a single top-level group to contain ZTest and FFF
extensions.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Rename the subsystems group from `subsys` to `os_services`, aligning
with what we have on the Sphinx side.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Some Doxygen groups do not belong to a specific header, they are used to
group multiple other sub-groups defined in other headers. For this
purpose we have the groups.dox file, there's no need to use device.h for
that.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit replaces the Zephyr logo for the HTML documentations with
the new registered trademark version.
Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
Adjust the Doxygen theme (based on doxygen-awesome) to match the Sphinx
theme. While not perfect, the experience should now be more consistent.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Add an external group definition file. It can be used to create high
level group for things like subsystems, as there is no header such as
"subsys.h" where these type of logical groups can be defined.
This approach is followed by projects such as pipewire to organize
Doxygen modules.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Use the doxygen-awesome theme to improve the look and feel of the
Doxygen API documentation.
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Anas Nashif
Gerard Marull-Paretas
Benjamin Cabé
Ederson de Souza
Bjarki Arge Andreasen
Florian Grandel
Andy Sinclair
Gerard Marull-Paretas
Stephanos Ioannidis
Nazar Kazakov