Skip to content

doc(doxygen): Fail when doxygen warning #587

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

doc(doxygen): Fail when doxygen warning #587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48befd8
doc(doxygen): Fail when doxygen warning
espzav Jun 24, 2025
ec39121
x
espzav Jun 26, 2025
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/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
- [ ] CI passing

# Change description
_Please describe your change here_
_Please describe your change here_
4 changes: 3 additions & 1 deletion Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ PROJECT_BRIEF = "Board support packages for development boards using Es
OUTPUT_DIRECTORY = ./doxygen_output
OPTIMIZE_OUTPUT_FOR_C = YES
WARN_IF_UNDOCUMENTED = NO
WARN_AS_ERROR = YES
INPUT = ./
RECURSIVE = YES
EXCLUDE = docu \
Expand All @@ -21,4 +22,5 @@ PREDEFINED = \
ESP_LVGL_PORT_TOUCH_COMPONENT=1 \
ESP_LVGL_PORT_BUTTON_COMPONENT=1 \
ESP_LVGL_PORT_KNOB_COMPONENT=1 \
ESP_LVGL_PORT_USB_HOST_HID_COMPONENT=1
ESP_LVGL_PORT_USB_HOST_HID_COMPONENT=1 \
esp_io_expander_handle_t=void*
2 changes: 1 addition & 1 deletion SquareLine/boards/v9/m5stack_core_2/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@
"__ESP_BOARD_INCLUDE__": "bsp/esp-bsp.h",
"__ESP_BOARD_I2C_INIT__": "/* Initialize I2C (for touch) */\n bsp_i2c_init();"
}
}
}
32 changes: 16 additions & 16 deletions bsp/esp-box-3/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,29 +61,29 @@ ESP32-S3-BOX-3 also uses a Type-C USB connector that provides 5 V of power input

## LVGL Benchmark

**DATE:** 11.06.2025 02:27
**DATE:** 22.06.2025 02:28

**LVGL version:** 9.3.0

| Name | Avg. CPU | Avg. FPS | Avg. time | render time | flush time |
| ---- | :------: | :------: | :-------: | :---------: | :--------: |
| Empty screen | 94% | 26 | 34 | 3 | 31 |
| Moving wallpaper | 97% | 25 | 36 | 5 | 31 |
| Empty screen | 93% | 25 | 34 | 3 | 31 |
| Moving wallpaper | 97% | 25 | 36 | 6 | 30 |
| Single rectangle | 10% | 91 | 0 | 0 | 0 |
| Multiple rectangles | 92% | 51 | 16 | 3 | 13 |
| Multiple RGB images | 8% | 89 | 0 | 0 | 0 |
| Multiple ARGB images | 21% | 88 | 2 | 1 | 1 |
| Rotated ARGB images | 82% | 55 | 17 | 12 | 5 |
| Multiple labels | 88% | 79 | 10 | 2 | 8 |
| Screen sized text | 98% | 15 | 58 | 27 | 31 |
| Multiple arcs | 18% | 89 | 0 | 0 | 0 |
| Containers | 34% | 73 | 17 | 5 | 12 |
| Containers with overlay | 88% | 20 | 45 | 15 | 30 |
| Containers with opa | 49% | 70 | 19 | 7 | 12 |
| Containers with opa_layer | 60% | 53 | 27 | 15 | 12 |
| Containers with scrolling | 96% | 20 | 43 | 12 | 31 |
| Multiple rectangles | 90% | 51 | 16 | 3 | 13 |
| Multiple RGB images | 15% | 90 | 0 | 0 | 0 |
| Multiple ARGB images | 18% | 87 | 2 | 1 | 1 |
| Rotated ARGB images | 73% | 55 | 17 | 12 | 5 |
| Multiple labels | 89% | 79 | 10 | 3 | 7 |
| Screen sized text | 98% | 15 | 59 | 29 | 30 |
| Multiple arcs | 15% | 92 | 0 | 0 | 0 |
| Containers | 32% | 72 | 15 | 4 | 11 |
| Containers with overlay | 89% | 20 | 46 | 15 | 31 |
| Containers with opa | 47% | 70 | 19 | 7 | 12 |
| Containers with opa_layer | 60% | 54 | 27 | 14 | 13 |
| Containers with scrolling | 96% | 21 | 44 | 13 | 31 |
| Widgets demo | 97% | 25 | 25 | 11 | 14 |
| All scenes avg. | 64% | 54 | 21 | 7 | 14 |
| All scenes avg. | 63% | 54 | 21 | 7 | 14 |



Expand Down
2 changes: 1 addition & 1 deletion bsp/esp-box-3/esp-box-3.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ static bool spi_sd_initialized = false;
* @brief I2C handle for BSP usage
*
* In IDF v5.4 you can call i2c_master_get_bus_handle(BSP_I2C_NUM, i2c_master_bus_handle_t *ret_handle)
* from #include "esp_private/i2c_platform.h" to get this handle
* from include "esp_private/i2c_platform.h" to get this handle
*
* For IDF 5.2 and 5.3 you must call bsp_i2c_get_handle()
*/
Expand Down
2 changes: 1 addition & 1 deletion bsp/esp32_c3_lcdkit/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ idf_component_register(
REQUIRES
"driver"
"spiffs"
)
)
36 changes: 18 additions & 18 deletions bsp/esp32_p4_function_ev_board/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,29 +89,29 @@ This BSP supports HDMI converter Lontium LT8912B. Follow these rules for using i

## LVGL Benchmark

**DATE:** 11.06.2025 02:25
**DATE:** 22.06.2025 02:31

**LVGL version:** 9.3.0

| Name | Avg. CPU | Avg. FPS | Avg. time | render time | flush time |
| ---- | :------: | :------: | :-------: | :---------: | :--------: |
| Empty screen | 56% | 88 | 5 | 4 | 1 |
| Moving wallpaper | 88% | 71 | 10 | 8 | 2 |
| Single rectangle | 18% | 88 | 1 | 1 | 0 |
| Multiple rectangles | 42% | 90 | 2 | 2 | 0 |
| Multiple RGB images | 27% | 96 | 1 | 1 | 0 |
| Multiple ARGB images | 59% | 91 | 6 | 6 | 0 |
| Rotated ARGB images | 89% | 60 | 14 | 14 | 0 |
| Multiple labels | 93% | 61 | 13 | 12 | 1 |
| Screen sized text | 99% | 13 | 71 | 69 | 2 |
| Multiple arcs | 98% | 46 | 18 | 16 | 2 |
| Containers | 27% | 88 | 3 | 3 | 0 |
| Containers with overlay | 91% | 28 | 31 | 29 | 2 |
| Containers with opa | 32% | 93 | 4 | 4 | 0 |
| Containers with opa_layer | 62% | 73 | 12 | 12 | 0 |
| Containers with scrolling | 98% | 28 | 32 | 30 | 2 |
| Widgets demo | 99% | 17 | 50 | 49 | 1 |
| All scenes avg. | 67% | 64 | 16 | 16 | 0 |
| Empty screen | 55% | 88 | 5 | 3 | 2 |
| Moving wallpaper | 88% | 71 | 10 | 7 | 3 |
| Single rectangle | 23% | 88 | 1 | 1 | 0 |
| Multiple rectangles | 40% | 90 | 2 | 2 | 0 |
| Multiple RGB images | 29% | 96 | 1 | 1 | 0 |
| Multiple ARGB images | 56% | 91 | 6 | 6 | 0 |
| Rotated ARGB images | 85% | 60 | 14 | 14 | 0 |
| Multiple labels | 92% | 61 | 13 | 12 | 1 |
| Screen sized text | 99% | 13 | 72 | 69 | 3 |
| Multiple arcs | 98% | 47 | 17 | 16 | 1 |
| Containers | 29% | 90 | 3 | 3 | 0 |
| Containers with overlay | 92% | 28 | 32 | 30 | 2 |
| Containers with opa | 33% | 90 | 4 | 4 | 0 |
| Containers with opa_layer | 61% | 73 | 12 | 12 | 0 |
| Containers with scrolling | 98% | 28 | 31 | 29 | 2 |
| Widgets demo | 99% | 17 | 50 | 48 | 2 |
| All scenes avg. | 67% | 64 | 17 | 16 | 1 |



Expand Down
6 changes: 0 additions & 6 deletions bsp/esp32_s2_kaluga_kit/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -591,12 +591,6 @@ There is no deinit audio function. Users can free audio resources by calling i2s



**Warning:**

The type of i2s\_config param is depending on IDF version.



**Parameters:**


Expand Down
2 changes: 1 addition & 1 deletion bsp/esp32_s2_kaluga_kit/esp32_s2_kaluga_kit.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ static const char *TAG = "Kaluga";
* @brief I2C handle for BSP usage
*
* In IDF v5.4 you can call i2c_master_get_bus_handle(BSP_I2C_NUM, i2c_master_bus_handle_t *ret_handle)
* from #include "esp_private/i2c_platform.h" to get this handle
* from include "esp_private/i2c_platform.h" to get this handle
*
* For IDF 5.2 and 5.3 you must call bsp_i2c_get_handle()
*/
Expand Down
1 change: 0 additions & 1 deletion bsp/esp32_s2_kaluga_kit/include/bsp/esp32_s2_kaluga_kit.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,6 @@ extern "C" {
* @brief Init audio
*
* @note There is no deinit audio function. Users can free audio resources by calling i2s_del_channel()
* @warning The type of i2s_config param is depending on IDF version.
* @param[in] i2s_config I2S configuration. Pass NULL to use default values (Mono, duplex, 16bit, 22050 Hz)
* @return
* - ESP_OK On success
Expand Down
2 changes: 1 addition & 1 deletion bsp/esp32_s3_eye/esp32_s3_eye.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ static const char *TAG = "S3-EYE";
* @brief I2C handle for BSP usage
*
* In IDF v5.4 you can call i2c_master_get_bus_handle(BSP_I2C_NUM, i2c_master_bus_handle_t *ret_handle)
* from #include "esp_private/i2c_platform.h" to get this handle
* from include "esp_private/i2c_platform.h" to get this handle
*
* For IDF 5.2 and 5.3 you must call bsp_i2c_get_handle()
*/
Expand Down
2 changes: 1 addition & 1 deletion bsp/esp32_s3_korvo_2/esp32_s3_korvo_2.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ static const char *TAG = "S3-KORVO-2";
* @brief I2C handle for BSP usage
*
* In IDF v5.4 you can call i2c_master_get_bus_handle(BSP_I2C_NUM, i2c_master_bus_handle_t *ret_handle)
* from #include "esp_private/i2c_platform.h" to get this handle
* from include "esp_private/i2c_platform.h" to get this handle
*
* For IDF 5.2 and 5.3 you must call bsp_i2c_get_handle()
*/
Expand Down
32 changes: 16 additions & 16 deletions bsp/esp32_s3_lcd_ev_board/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,29 +96,29 @@ Based on the above configurations, there are three different anti-tearing modes

## LVGL Benchmark

**DATE:** 11.06.2025 02:31
**DATE:** 22.06.2025 02:34

**LVGL version:** 9.3.0

| Name | Avg. CPU | Avg. FPS | Avg. time | render time | flush time |
| ---- | :------: | :------: | :-------: | :---------: | :--------: |
| Empty screen | 98% | 18 | 51 | 30 | 21 |
| Moving wallpaper | 100% | 8 | 109 | 84 | 25 |
| Single rectangle | 99% | 35 | 24 | 1 | 23 |
| Moving wallpaper | 100% | 8 | 110 | 85 | 25 |
| Single rectangle | 99% | 35 | 25 | 2 | 23 |
| Multiple rectangles | 99% | 32 | 27 | 18 | 9 |
| Multiple RGB images | 99% | 27 | 30 | 23 | 7 |
| Multiple ARGB images | 99% | 16 | 51 | 36 | 15 |
| Rotated ARGB images | 99% | 14 | 62 | 53 | 9 |
| Multiple labels | 100% | 18 | 49 | 36 | 13 |
| Screen sized text | 100% | 8 | 108 | 92 | 16 |
| Multiple arcs | 99% | 35 | 23 | 7 | 16 |
| Containers | 99% | 15 | 55 | 42 | 13 |
| Containers with overlay | 99% | 9 | 87 | 75 | 12 |
| Containers with opa | 99% | 12 | 71 | 57 | 14 |
| Containers with opa_layer | 99% | 6 | 147 | 134 | 13 |
| Containers with scrolling | 99% | 11 | 81 | 62 | 19 |
| Widgets demo | 99% | 7 | 99 | 86 | 13 |
| All scenes avg. | 99% | 16 | 66 | 52 | 14 |
| Multiple RGB images | 99% | 26 | 33 | 24 | 9 |
| Multiple ARGB images | 100% | 16 | 51 | 36 | 15 |
| Rotated ARGB images | 99% | 14 | 62 | 52 | 10 |
| Multiple labels | 100% | 17 | 47 | 36 | 11 |
| Screen sized text | 100% | 8 | 109 | 92 | 17 |
| Multiple arcs | 99% | 35 | 23 | 8 | 15 |
| Containers | 99% | 15 | 56 | 45 | 11 |
| Containers with overlay | 100% | 9 | 90 | 76 | 14 |
| Containers with opa | 100% | 11 | 73 | 58 | 15 |
| Containers with opa_layer | 100% | 5 | 149 | 135 | 14 |
| Containers with scrolling | 99% | 11 | 81 | 63 | 18 |
| Widgets demo | 99% | 7 | 100 | 87 | 13 |
| All scenes avg. | 99% | 16 | 67 | 52 | 15 |



Expand Down
2 changes: 1 addition & 1 deletion bsp/esp32_s3_lcd_ev_board/src/esp32_s3_lcd_ev_board.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ static const char *TAG = "S3-LCD-EV-BOARD";
* @brief I2C handle for BSP usage
*
* In IDF v5.4 you can call i2c_master_get_bus_handle(BSP_I2C_NUM, i2c_master_bus_handle_t *ret_handle)
* from #include "esp_private/i2c_platform.h" to get this handle
* from include "esp_private/i2c_platform.h" to get this handle
*
* For IDF 5.2 and 5.3 you must call bsp_i2c_get_handle()
*/
Expand Down
2 changes: 1 addition & 1 deletion bsp/esp_bsp_devkit/src/esp_bsp_devkit.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ static const char *TAG = "BSP-devkit";
* @brief I2C handle for BSP usage
*
* In IDF v5.4 you can call i2c_master_get_bus_handle(BSP_I2C_NUM, i2c_master_bus_handle_t *ret_handle)
* from #include "esp_private/i2c_platform.h" to get this handle
* from include "esp_private/i2c_platform.h" to get this handle
*
* For IDF 5.2 and 5.3 you must call bsp_i2c_get_handle()
*/
Expand Down
2 changes: 1 addition & 1 deletion bsp/esp_bsp_generic/src/esp_bsp_generic.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ static esp_lcd_touch_handle_t tp; // LCD touch handle
* @brief I2C handle for BSP usage
*
* In IDF v5.4 you can call i2c_master_get_bus_handle(BSP_I2C_NUM, i2c_master_bus_handle_t *ret_handle)
* from #include "esp_private/i2c_platform.h" to get this handle
* from include "esp_private/i2c_platform.h" to get this handle
*
* For IDF 5.2 and 5.3 you must call bsp_i2c_get_handle()
*/
Expand Down
2 changes: 1 addition & 1 deletion bsp/m5_atom_s3/m5_atom_s3.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ static lv_display_t *disp;
* @brief I2C handle for BSP usage
*
* In IDF v5.4 you can call i2c_master_get_bus_handle(BSP_I2C_NUM, i2c_master_bus_handle_t *ret_handle)
* from #include "esp_private/i2c_platform.h" to get this handle
* from include "esp_private/i2c_platform.h" to get this handle
*
* For IDF 5.2 and 5.3 you must call bsp_i2c_get_handle()
*/
Expand Down
36 changes: 18 additions & 18 deletions bsp/m5dial/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,29 +69,29 @@ M5Dial provides versatile power supply options to cater to various needs. It acc

## LVGL Benchmark

**DATE:** 11.06.2025 02:37
**DATE:** 22.06.2025 02:41

**LVGL version:** 9.3.0

| Name | Avg. CPU | Avg. FPS | Avg. time | render time | flush time |
| ---- | :------: | :------: | :-------: | :---------: | :--------: |
| Empty screen | 96% | 38 | 23 | 5 | 18 |
| Moving wallpaper | 96% | 41 | 23 | 11 | 12 |
| Single rectangle | 33% | 97 | 1 | 0 | 1 |
| Multiple rectangles | 91% | 63 | 12 | 10 | 2 |
| Multiple RGB images | 34% | 92 | 1 | 1 | 0 |
| Multiple ARGB images | 37% | 92 | 4 | 3 | 1 |
| Rotated ARGB images | 80% | 61 | 16 | 16 | 0 |
| Multiple labels | 57% | 91 | 4 | 4 | 0 |
| Screen sized text | 98% | 23 | 39 | 38 | 1 |
| Multiple arcs | 29% | 90 | 1 | 1 | 0 |
| Containers | 39% | 83 | 13 | 7 | 6 |
| Containers with overlay | 94% | 33 | 27 | 20 | 7 |
| Containers with opa | 49% | 81 | 16 | 10 | 6 |
| Containers with opa_layer | 53% | 75 | 18 | 16 | 2 |
| Containers with scrolling | 99% | 32 | 28 | 22 | 6 |
| Widgets demo | 99% | 27 | 20 | 18 | 2 |
| All scenes avg. | 67% | 63 | 15 | 11 | 4 |
| Empty screen | 96% | 38 | 22 | 5 | 17 |
| Moving wallpaper | 96% | 41 | 23 | 12 | 11 |
| Single rectangle | 30% | 96 | 0 | 0 | 0 |
| Multiple rectangles | 90% | 63 | 11 | 8 | 3 |
| Multiple RGB images | 31% | 90 | 1 | 1 | 0 |
| Multiple ARGB images | 34% | 91 | 3 | 3 | 0 |
| Rotated ARGB images | 80% | 60 | 16 | 15 | 1 |
| Multiple labels | 54% | 96 | 6 | 6 | 0 |
| Screen sized text | 97% | 24 | 39 | 37 | 2 |
| Multiple arcs | 27% | 88 | 1 | 1 | 0 |
| Containers | 36% | 83 | 14 | 9 | 5 |
| Containers with overlay | 89% | 33 | 26 | 20 | 6 |
| Containers with opa | 45% | 78 | 15 | 11 | 4 |
| Containers with opa_layer | 53% | 73 | 19 | 17 | 2 |
| Containers with scrolling | 95% | 32 | 27 | 22 | 5 |
| Widgets demo | 99% | 27 | 19 | 18 | 1 |
| All scenes avg. | 65% | 63 | 14 | 11 | 3 |



Expand Down
10 changes: 2 additions & 8 deletions bsp/m5stack_core_2/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -644,7 +644,7 @@ esp_codec_dev_close(mic_codec_dev);
| ---: | :--- |
| esp\_codec\_dev\_handle\_t | [**bsp\_audio\_codec\_speaker\_init**](#function-bsp_audio_codec_speaker_init) (void) <br>_Initialize speaker codec device._ |
| const audio\_codec\_data\_if\_t \* | [**bsp\_audio\_get\_codec\_itf**](#function-bsp_audio_get_codec_itf) (void) <br>_Get codec I2S interface (initialized in bsp\_audio\_init)_ |
| esp\_err\_t | [**bsp\_audio\_init**](#function-bsp_audio_init) (const i2s\_std\_config\_t \*i2s\_config) <br>_Init audio._ |
| esp\_err\_t | [**bsp\_audio\_init**](#function-bsp_audio_init) (const i2s\_config\_t \*i2s\_config) <br>_Init audio._ |

## Macros

Expand Down Expand Up @@ -695,7 +695,7 @@ const audio_codec_data_if_t * bsp_audio_get_codec_itf (
_Init audio._
```c
esp_err_t bsp_audio_init (
const i2s_std_config_t *i2s_config
const i2s_config_t *i2s_config
)
```

Expand All @@ -706,12 +706,6 @@ There is no deinit audio function. Users can free audio resources by calling i2s



**Warning:**

The type of i2s\_config param is depending on IDF version.



**Parameters:**


Expand Down
5 changes: 0 additions & 5 deletions bsp/m5stack_core_2/include/bsp/m5stack_core_2.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,6 @@ extern "C" {
* @brief Init audio
*
* @note There is no deinit audio function. Users can free audio resources by calling i2s_del_channel()
* @warning The type of i2s_config param is depending on IDF version.
* @param[in] i2s_config I2S configuration. Pass NULL to use default values (Mono, duplex, 16bit, 22050 Hz)
* @return
* - ESP_OK On success
Expand All @@ -144,11 +143,7 @@ extern "C" {
* - ESP_ERR_NO_MEM No memory for storing the channel information
* - ESP_ERR_INVALID_STATE This channel has not initialized or already started
*/
#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 0, 0)
esp_err_t bsp_audio_init(const i2s_config_t *i2s_config);
#else
esp_err_t bsp_audio_init(const i2s_std_config_t *i2s_config);
#endif

/**
* @brief Get codec I2S interface (initialized in bsp_audio_init)
Expand Down
Loading
Loading