espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-07-31 11:17:20 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'bugfix/define__DOXYGEN___v4.2' into 'release/v4.2'

Browse Source 
docs: define __DOXYGEN__ for doxygen builds (v4.2)

See merge request espressif/esp-idf!15681
This commit is contained in:
Marius Vikhammer
2021-11-04 05:57:07 +00:00
parent f370d5089f 86c5d3136e
commit 49c1dc43f1
2 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
components/app_update/include/esp_ota_ops.h
View File

@@ -313,9 +313,9 @@ typedef enum {
/** /**
* @brief Revokes the old signature digest. To be called in the application after the rollback logic. * @brief Revokes the old signature digest. To be called in the application after the rollback logic.
* *
* Relevant for Secure boot v2 on ESP32-S2 where upto 3 key digests can be stored (Key #N-1, Key #N, Key #N+1). * Relevant for Secure boot v2 on ESP32-S2 where upto 3 key digests can be stored (Key N-1, Key N, Key N+1).
* When key #N-1 used to sign an app is invalidated, an OTA update is to be sent with an app signed with key #N-1 & Key #N. * When key N-1 used to sign an app is invalidated, an OTA update is to be sent with an app signed with key N-1 & Key N.
* After successfully booting the OTA app should call this function to revoke Key #N-1. * After successfully booting the OTA app should call this function to revoke Key N-1.
* *
* @param index - The index of the signature block to be revoked * @param index - The index of the signature block to be revoked
* *

1
docs/Doxyfile
View File

@@ -219,6 +219,7 @@ MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES EXPAND_ONLY_PREDEF = YES
PREDEFINED = \ PREDEFINED = \
$(ENV_DOXYGEN_DEFINES) \ $(ENV_DOXYGEN_DEFINES) \
__DOXYGEN__=1 \
__attribute__(x)= \ __attribute__(x)= \
_Static_assert()= \ _Static_assert()= \
IDF_DEPRECATED(X)= \ IDF_DEPRECATED(X)= \