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.

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

doc: doxygen: some minor fixes #75936

Merged
merged 10 commits into from
Jul 18, 2024
1 change: 1 addition & 0 deletions doc/_doxygen/groups.dox
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@

@brief Modem APIs
@defgroup modem Modem APIs
@ingroup connectivity
@since 3.5
@version 0.1.0
@{
Expand Down
3 changes: 1 addition & 2 deletions doc/zephyr.doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -925,7 +925,6 @@ INPUT = @ZEPHYR_BASE@/doc/_doxygen/mainpage.md \
@ZEPHYR_BASE@/doc/_doxygen/groups.dox \
@ZEPHYR_BASE@/kernel/include/kernel_arch_interface.h \
@ZEPHYR_BASE@/include/zephyr/arch/cache.h \
@ZEPHYR_BASE@/include/zephyr/sys/arch_interface.h \
@ZEPHYR_BASE@/include/zephyr/sys/atomic.h \
@ZEPHYR_BASE@/include/ \
@ZEPHYR_BASE@/lib/libc/minimal/include/ \
Expand Down Expand Up @@ -1106,7 +1105,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE = mainpage.md
USE_MDFILE_AS_MAINPAGE = @ZEPHYR_BASE@/doc/_doxygen/mainpage.md

# The Fortran standard specifies that for fixed formatted Fortran code all
# characters from position 72 are to be considered as comment. A common
Expand Down
1 change: 1 addition & 0 deletions include/zephyr/bindesc.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ extern "C" {
/**
* @brief Binary Descriptor Definition
* @defgroup bindesc_define Bindesc Define
* @ingroup os_services
* @{
*/

Expand Down
2 changes: 1 addition & 1 deletion include/zephyr/debug/mipi_stp_decoder.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ extern "C" {

/**
* @defgroup mipi_stp_decoder_apis STP Decoder API
* @ingroup coresight_apis
* @ingroup os_services
* @{
*/

Expand Down
1 change: 1 addition & 0 deletions include/zephyr/debug/symtab.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ extern "C" {

/**
* @defgroup symtab_apis Symbol Table API
* @ingroup os_services
* @{
*/

Expand Down
2 changes: 1 addition & 1 deletion include/zephyr/drivers/tee.h
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
/**
* @brief Trusted Execution Environment Interface
* @defgroup tee_interface TEE Interface
* @ingroup security
* @ingroup io_interfaces
* @{
*
* The generic interface to work with Trusted Execution Environment (TEE).
Expand Down
1 change: 1 addition & 0 deletions include/zephyr/dt-bindings/sensor/icm42688.h
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

/**
* @defgroup ICM42688 Invensense (TDK) ICM42688 DT Options
* @ingroup sensor_interface
* @{
*/

Expand Down
8 changes: 4 additions & 4 deletions include/zephyr/net/dns_sd.h
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ extern "C" {
* The service can be referenced using the @p id variable.
*
* Example (with TXT):
* @code{c}
* @code{.c}
* #include <zephyr/net/dns_sd.h>
* static const bar_txt[] = {
* "\x06" "path=/"
Expand All @@ -140,7 +140,7 @@ extern "C" {
* static uint16_t bar_port;
* DNS_SD_REGISTER_TCP_SERVICE(bar, CONFIG_NET_HOSTNAME,
* "_bar", "local", bar_txt, &bar_port);
* @endcode{c}
* @endcode
*
* TXT records begin with a single length byte (hex-encoded)
* and contain key=value pairs. Thus, the length of the key-value pair
Expand Down Expand Up @@ -172,13 +172,13 @@ extern "C" {
* The service can be referenced using the @p id variable.
*
* Example (no TXT):
* @code{c}
* @code{.c}
* #include <zephyr/net/dns_sd.h>
* #include <zephyr/sys/byteorder.h>
* static const foo_port = sys_cpu_to_be16(4242);
* DNS_SD_REGISTER_UDP_SERVICE(foo, CONFIG_NET_HOSTNAME,
* "_foo", DNS_SD_EMPTY_TXT, &foo_port);
* @endcode{c}
* @endcode
*
* @param id variable name for the DNS-SD service record
* @param instance name of the service instance such as "My TFTP Server"
Expand Down
1 change: 0 additions & 1 deletion lib/libc/armstdc/include/errno.h
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
* 'C Library ABI for the Arm® Architecture, 2021Q1'
*
* @defgroup system_errno Error numbers
* @ingroup c_std_lib
* @{
*/

Expand Down
1 change: 0 additions & 1 deletion lib/libc/armstdc/src/errno.c
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
* 'C Library ABI for the Arm® Architecture, 2021Q1'
*
* @defgroup system_errno Error numbers
* @ingroup c_std_lib
* @{
*/

Expand Down
1 change: 0 additions & 1 deletion lib/libc/minimal/include/errno.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
* Error codes returned by functions.
* Includes a list of those defined by IEEE Std 1003.1-2017.
* @defgroup system_errno Error numbers
* @ingroup c_std_lib
* @{
*/

Expand Down
Loading