Kaynağa Gözat

docs: define __DOXYGEN__ for doxygen builds

Some docs depended on __DOXYGEN__ but this was never defined anywhere.
Marius Vikhammer 4 yıl önce
ebeveyn
işleme
86c5d3136e
2 değiştirilmiş dosya ile 6 ekleme ve 5 silme
  1. 5 5
      components/app_update/include/esp_ota_ops.h
  2. 1 0
      docs/Doxyfile

+ 5 - 5
components/app_update/include/esp_ota_ops.h

@@ -49,7 +49,7 @@ typedef uint32_t esp_ota_handle_t;
 
 /**
  * @brief   Return esp_app_desc structure. This structure includes app version.
- * 
+ *
  * Return description for running app.
  * @return Pointer to esp_app_desc structure.
  */
@@ -224,7 +224,7 @@ const esp_partition_t* esp_ota_get_next_update_partition(const esp_partition_t *
 
 /**
  * @brief Returns esp_app_desc structure for app partition. This structure includes app version.
- * 
+ *
  * Returns a description for the requested app partition.
  * @param[in] partition     Pointer to app partition. (only app partition)
  * @param[out] app_desc     Structure of info about app.
@@ -313,9 +313,9 @@ typedef enum {
 /**
  * @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).
- * 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.
+ * 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.
+ * 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
  *

+ 1 - 0
docs/Doxyfile

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