feat(update): Add Doxygen style documentation for the Update class by me-no-dev · Pull Request #12243 · espressif/arduino-esp32

me-no-dev · 2026-01-14T20:47:55Z

This pull request enhances the documentation and clarity of the UpdateClass API in Update.h by replacing terse or outdated comments with detailed Doxygen-style documentation. It also improves the readability of macro definitions by adding descriptive comments for each constant. No functional or behavioral changes have been made to the code itself.

The most important changes are:

API Documentation Improvements:

Replaced all block comments above public methods in UpdateClass with detailed Doxygen-style documentation, describing parameters, return values, and method behavior.
Added Doxygen-style documentation for methods related to MD5 digest retrieval and signature verification, providing clearer usage guidance.

Macro and Constant Clarification:

Added descriptive comments to all macro constants (e.g., UPDATE_ERROR_*, U_FLASH, ENCRYPTED_BLOCK_SIZE) to clarify their purpose and usage throughout the file.

Fixes: #12241

me-no-dev · 2026-01-14T20:48:32Z

@lbernstone does this fulfill your requirement?

github-actions · 2026-01-14T20:48:33Z

	Messages
📖	🎉 Good Job! All checks are passing!

👋 Hello me-no-dev, we appreciate your contribution to this project!

📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...

This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...

We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against c813e84

cores/esp32/esp32-hal-misc.c

github-actions · 2026-01-14T21:20:41Z

Test Results

90 files 90 suites 32m 47s ⏱️
67 tests 67 ✅ 0 💤 0 ❌
683 runs 683 ✅ 0 💤 0 ❌

Results for commit c813e84.

♻️ This comment has been updated with latest results.

github-actions · 2026-01-14T22:42:13Z

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

Memory	FLASH [bytes]		FLASH [%]		RAM [bytes]		RAM [%]
Target	DEC	INC	DEC	INC	DEC	INC	DEC	INC
ESP32	💚 -16	0	0.00	0.00	0	0	0.00	0.00
ESP32C3	0	0	0.00	0.00	0	0	0.00	0.00
ESP32C5	0	0	0.00	0.00	0	0	0.00	0.00
ESP32C6	0	0	0.00	0.00	0	0	0.00	0.00
ESP32H2	0	0	0.00	0.00	0	0	0.00	0.00
ESP32P4	0	0	0.00	0.00	0	0	0.00	0.00
ESP32S2	0	0	0.00	0.00	0	0	0.00	0.00
ESP32S3	0	0	0.00	0.00	0	0	0.00	0.00

Click to expand the detailed deltas report [usage change in BYTES]

Target	ESP32		ESP32C3		ESP32C5		ESP32C6		ESP32H2		ESP32P4		ESP32S2		ESP32S3
Example	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM	FLASH	RAM
libraries/ArduinoOTA/examples/BasicOTA	0	0	0	0	0	0	0	0	-	-	0	0	0	0	0	0
libraries/ArduinoOTA/examples/SignedOTA	0	0	0	0	0	0	0	0	-	-	0	0	0	0	0	0
libraries/AsyncUDP/examples/AsyncUDPClient	0	0	0	0	0	0	0	0	-	-	0	0	0	0	0	0
libraries/AsyncUDP/examples/AsyncUDPMulticastServer	0	0	0	0	0	0	0	0	-	-	0	0	0	0	0	0
libraries/AsyncUDP/examples/AsyncUDPServer	0	0	0	0	-	-	0	0	-	-	0	0	0	0	0	0
libraries/BLE/examples/Beacon_Scanner	0	0	0	0	-	-	-	-	0	0	0	0	-	-	0	0
libraries/BLE/examples/Client	0	0	0	0	-	-	-	-	0	0	0	0	-	-	0	0
libraries/BLE/examples/Client_Server	0	0	0	0	-	-	-	-	0	0	0	0	-	-	-	-
libraries/BLE/examples/Client_multiconnect	0	0	0	0	-	-	-	-	0	0	0	0	-	-	-	-
libraries/BLE/examples/Client_secure_static_passkey	0	0	0	0	-	-	-	-	0	0	0	0	-	-	-	-
libraries/BLE/examples/EddystoneTLM_Beacon	0	0	0	0	-	-	-	-	0	0	0	0	-	-	-	-
libraries/BLE/examples/EddystoneURL_Beacon	0	0	0	0	-	-	-	-	0	0	0	0	-	-	-	-
libraries/BLE/examples/FreeBTMemory	0	0	0	0	-	-	-	-	0	0	0	0	-	-	-	-
libraries/BLE/examples/Notify	0	0	0	0	-	-	-	-	0	0	0	0	-	-	-	-
libraries/BLE/examples/Scan	0	0	0	0	-	-	-	-	0	0	0	0	-	-	-	-
libraries/BLE/examples/Server	0	0	0	0	-	-	-	-	0	0	0	0	-	-	-	-
libraries/BLE/examples/Server_multiconnect	0	0	0	0	-	-	-	-	0	0	0	0	-	-	-	-
libraries/BLE/examples/Server_secure_static_passkey	0	0	0	0	-	-	-	-	0	0	0	0	-	-	-	-
libraries/BLE/examples/UART	0	0	0	0	-	-	-	-	0	0	0	0	-	-	-	-
libraries/BLE/examples/Write	0	0	0	0	-	-	-	-	0	0	0	0	-	-	-	-
libraries/BLE/examples/iBeacon	0	0	0	0	-	-	-	-	0	0	0	0	-	-	-	-
libraries/BluetoothSerial/examples/DiscoverConnect	0	0	-	-	-	-	-	-	-	-	-	-	-	-	-	-
libraries/BluetoothSerial/examples/GetLocalMAC	0	0	-	-	-	-	-	-	-	-	-	-	-	-	-	-
libraries/BluetoothSerial/examples/SerialToSerialBT	0	0	-	-	-	-	-	-	-	-	-	-	-	-	-	-
libraries/BluetoothSerial/examples/SerialToSerialBTM	0	0	-	-	-	-	-	-	-	-	-	-	-	-	-	-
libraries/BluetoothSerial/examples/SerialToSerialBT_Legacy	0	0	-	-	-	-	-	-	-	-	-	-	-	-	-	-
libraries/BluetoothSerial/examples/SerialToSerialBT_SSP	0	0	-	-	-	-	-	-	-	-	-	-	-	-	-	-
libraries/BluetoothSerial/examples/bt_classic_device_discovery	0	0	-	-	-	-	-	-	-	-	-	-	-	-	-	-
libraries/BluetoothSerial/examples/bt_remove_paired_devices	0	0	-	-	-	-	-	-	-	-	-	-	-	-	-	-
libraries/DNSServer/examples/CaptivePortal	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/EEPROM/examples/eeprom_class	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/EEPROM/examples/eeprom_extra	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/EEPROM/examples/eeprom_write	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/AnalogOut/LEDCFade	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/AnalogOut/LEDCSingleChannel	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/AnalogOut/LEDCSoftwareFade	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/AnalogOut/SigmaDelta	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/AnalogOut/ledcFrequency	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/AnalogOut/ledcWrite_RGB	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/AnalogRead	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/AnalogReadContinuous	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/ArduinoStackSize	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/ArduinoWaitTimeBeforeStartingSketch	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/CI/CIBoardsTest	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/Camera/CameraWebServer	0	0	-	-	-	-	-	-	-	-	-	-	0	0	-	-
ESP32/examples/Camera/CameraWebServer (2)	0	0	-	-	-	-	-	-	-	-	-	-	0	0	-	-
libraries/ESP32/examples/ChipID/GetChipID	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/DeepSleep/ExternalWakeUp	0	0	-	-	-	-	-	-	-	-	-	-	0	0	-	-
libraries/ESP32/examples/DeepSleep/SmoothBlink_ULP_Code	0	0	-	-	-	-	-	-	-	-	-	-	-	-	-	-
libraries/ESP32/examples/DeepSleep/TimerWakeUp	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/ESP32/examples/DeepSleep/TouchWakeUp	0	0	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/ESP32/examples/FreeRTOS/BasicMultiThreading	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/FreeRTOS/Mutex	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/FreeRTOS/Queue	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/FreeRTOS/Semaphore	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/GPIO/BlinkRGB	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/GPIO/FunctionalInterrupt	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/GPIO/FunctionalInterruptLambda	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/GPIO/FunctionalInterruptStruct	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/GPIO/GPIOInterrupt	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/MacAddress/GetMacAddress	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/RMT/Legacy_RMT_Driver_Compatible	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/RMT/RMTCallback	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/RMT/RMTLoopback	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/RMT/RMTReadXJT	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/RMT/RMTWrite_RGB_LED	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/RMT/RMT_CPUFreq_Test	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/RMT/RMT_EndOfTransmissionState	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/RMT/RMT_LED_Blink	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/ResetReason/ResetReason	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/ResetReason/ResetReason2	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/Serial/BaudRateDetect_Demo	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/Serial/HardwareFlowControl_Demo	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/Serial/OnReceiveError_BREAK_Demo	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/Serial/OnReceive_Demo	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/Serial/RS485_Echo_Demo	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/Serial/RxFIFOFull_Demo	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/Serial/RxTimeout_Demo	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/Serial/Serial_All_CPU_Freqs	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/Serial/Serial_STD_Func_OnReceive	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/Serial/onReceiveExample	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/TWAI/TWAIreceive	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/TWAI/TWAItransmit	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/Template/ExampleTemplate	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/Time/SimpleTime	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/ESP32/examples/Timer/RepeatTimer	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/Timer/WatchdogTimer	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP32/examples/Touch/TouchButton	0	0	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/ESP32/examples/Touch/TouchInterrupt	0	0	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/ESP32/examples/Touch/TouchRead	0	0	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/ESP_I2S/examples/ES8388_loopback	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP_I2S/examples/Record_to_WAV	0	0	-	-	-	-	-	-	-	-	0	0	-	-	-	-
libraries/ESP_I2S/examples/Simple_tone	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/ESP_NOW/examples/ESP_NOW_Broadcast_Master	0	0	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/ESP_NOW/examples/ESP_NOW_Broadcast_Slave	0	0	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/ESP_NOW/examples/ESP_NOW_Network	0	0	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/ESP_NOW/examples/ESP_NOW_Serial	0	0	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/ESPmDNS/examples/mDNS-SD_Extended	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/ESPmDNS/examples/mDNS_Web_Server	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/Ethernet/examples/ETH_LAN8720	0	0	-	-	-	-	-	-	-	-	-	-	-	-	-	-
libraries/Ethernet/examples/ETH_TLK110	0	0	-	-	-	-	-	-	-	-	0	0	-	-	-	-
libraries/Ethernet/examples/ETH_W5500_Arduino_SPI	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Ethernet/examples/ETH_W5500_IDF_SPI	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Ethernet/examples/ETH_WIFI_BRIDGE	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/FFat/examples/FFat_Test	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/FFat/examples/FFat_time	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/HTTPClient/examples/Authorization	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/HTTPClient/examples/BasicHttpClient	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/HTTPClient/examples/BasicHttpsClient	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/HTTPClient/examples/CustomHeaders	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/HTTPClient/examples/HTTPClientEnterprise	0	0	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/HTTPClient/examples/ReuseConnection	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/HTTPClient/examples/StreamHttpClient	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/HTTPUpdate/examples/httpUpdate	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/HTTPUpdate/examples/httpUpdateSPIFFS	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/HTTPUpdate/examples/httpUpdateSecure	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/HTTPUpdateServer/examples/WebUpdater	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/Hash/examples/HEX	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Hash/examples/MD5	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Hash/examples/PBKDF2_HMAC	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Hash/examples/SHA1	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Hash/examples/SHA2	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Hash/examples/SHA3	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Hash/examples/SHA3Stream	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Insights/examples/DiagnosticsSmokeTest	0	0	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/Insights/examples/MinimalDiagnostics	0	0	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/LittleFS/examples/LITTLEFS_test	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/LittleFS/examples/LITTLEFS_time	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/Matter/examples/MatterColorLight	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterCommissionTest	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterComposedLights	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterContactSensor	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterDimmableLight	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterDimmablePlugin	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterEnhancedColorLight	💚 -16	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterEvents	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterFan	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterHumiditySensor	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterLambdaSingleCallbackManyEPs	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterMinimum	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterOccupancySensor	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterOccupancyWithHoldTime	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterOnIdentify	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterOnOffLight	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterOnOffPlugin	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterPressureSensor	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterRainSensor	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterSimpleBlinds	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterSmartButton	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterStatus	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterTemperatureControlledCabinet	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterTemperatureControlledCabinetLevels	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterTemperatureLight	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterTemperatureSensor	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterThermostat	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterWaterFreezeDetector	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterWaterLeakDetector	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Matter/examples/MatterWindowCovering	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/NetBIOS/examples/ESP_NBNST	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/NetworkClientSecure/examples/WiFiClientInsecure	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/NetworkClientSecure/examples/WiFiClientPSK	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/NetworkClientSecure/examples/WiFiClientSecure	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/NetworkClientSecure/examples/WiFiClientSecureEnterprise	0	0	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/NetworkClientSecure/examples/WiFiClientSecureProtocolUpgrade	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/NetworkClientSecure/examples/WiFiClientShowPeerCredentials	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/NetworkClientSecure/examples/WiFiClientTrustOnFirstUse	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/PPP/examples/PPP_Basic	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/PPP/examples/PPP_WIFI_BRIDGE	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/Preferences/examples/Prefs2Struct	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Preferences/examples/StartCounter	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/SD/examples/SD_Test	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/SD/examples/SD_time	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/SD_MMC/examples/SDMMC_Test	0	0	-	-	-	-	-	-	-	-	0	0	-	-	-	-
libraries/SD_MMC/examples/SDMMC_time	0	0	-	-	-	-	-	-	-	-	0	0	-	-	-	-
libraries/SPI/examples/SPI_Multiple_Buses	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/SPIFFS/examples/SPIFFS_Test	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/SPIFFS/examples/SPIFFS_time	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/SimpleBLE/examples/SimpleBleDevice	0	0	-	-	-	-	-	-	-	-	-	-	-	-	-	-
libraries/TFLiteMicro/examples/hello_world	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Ticker/examples/Blinker	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Ticker/examples/TickerBasic	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Ticker/examples/TickerParameter	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Update/examples/AWS_S3_OTA_Update	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/Update/examples/HTTPS_OTA_Update	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/Update/examples/HTTP_Client_AES_OTA_Update	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/Update/examples/HTTP_Server_AES_OTA_Update	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/Update/examples/OTAWebUpdater	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/Update/examples/SD_Update	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Update/examples/Signed_OTA_Update	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/AdvancedWebServer	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/ChunkWriting	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/FSBrowser	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/Filters	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/HelloServer	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/HttpAdvancedAuth	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/HttpAuthCallback	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/HttpAuthCallbackInline	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/HttpBasicAuth	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/HttpBasicAuthSHA1	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/HttpBasicAuthSHA1orBearerToken	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/Middleware	0	0	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/WebServer/examples/MultiHomedServers	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/PathArgServer	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/SDWebServer	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/SimpleAuthentification	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/UploadHugeFile	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/WebServer	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WebServer/examples/WebUpdate	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/FTM/FTM_Initiator	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/FTM/FTM_Responder	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/SimpleWiFiServer	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/WPS	0	0	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/WiFi/examples/WiFiAccessPoint	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/WiFiBlueToothSwitch	0	0	0	0	-	-	-	-	-	-	-	-	-	-	-	-
libraries/WiFi/examples/WiFiClient	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/WiFiClientBasic	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/WiFiClientConnect	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/WiFiClientEnterprise	0	0	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/WiFi/examples/WiFiClientEvents	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/WiFiClientStaticIP	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/WiFiExtender	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/WiFiIPv6	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/WiFiMulti	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/WiFiMultiAdvanced	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/WiFiScan	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/WiFiScanAsync	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/WiFiScanDualAntenna	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/WiFiScanTime	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/WiFiSmartConfig	0	0	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/WiFi/examples/WiFiTelnetToSerial	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFi/examples/WiFiUDPClient	0	0	0	0	-	-	-	-	-	-	0	0	0	0	-	-
libraries/WiFiProv/examples/WiFiProv	0	0	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/Wire/examples/WireMaster	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Wire/examples/WireScan	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Wire/examples/WireSlave	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Wire/examples/WireSlaveFunctionalCallback	0	0	0	0	-	-	-	-	0	0	0	0	0	0	-	-
libraries/Zigbee/examples/Zigbee_Analog_Input_Output	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Zigbee/examples/Zigbee_Color_Dimmer_Switch	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Zigbee/examples/Zigbee_Electrical_AC_Sensor	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Zigbee/examples/Zigbee_Electrical_AC_Sensor_MultiPhase	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Zigbee/examples/Zigbee_Fan_Control	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Zigbee/examples/Zigbee_Gateway	0	0	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/Zigbee/examples/Zigbee_Multistate_Input_Output	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Zigbee/examples/Zigbee_On_Off_MultiSwitch	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Zigbee/examples/Zigbee_On_Off_Switch	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Zigbee/examples/Zigbee_Power_Outlet	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Zigbee/examples/Zigbee_Range_Extender	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/Zigbee/examples/Zigbee_Thermostat	0	0	0	0	-	-	-	-	0	0	-	-	0	0	-	-
libraries/BLE/examples/Server_secure_authorization	-	-	0	0	-	-	-	-	0	0	-	-	-	-	-	-
libraries/ESP32/examples/HWCDC_Events	-	-	0	0	-	-	-	-	0	0	0	0	-	-	-	-
libraries/RainMaker/examples/RMakerCustom	-	-	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/RainMaker/examples/RMakerCustomAirCooler	-	-	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/RainMaker/examples/RMakerSonoffDualR3	-	-	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/RainMaker/examples/RMakerSwitch	-	-	0	0	-	-	-	-	-	-	-	-	0	0	-	-
libraries/ESP32/examples/AnalogOut/LEDCGammaFade	-	-	-	-	-	-	-	-	0	0	0	0	-	-	-	-
libraries/OpenThread/examples/CLI/COAP/coap_lamp	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/OpenThread/examples/CLI/COAP/coap_switch	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/OpenThread/examples/CLI/SimpleCLI	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/OpenThread/examples/CLI/SimpleNode	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/OpenThread/examples/CLI/SimpleThreadNetwork/ExtendedRouterNode	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/OpenThread/examples/CLI/SimpleThreadNetwork/LeaderNode	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/OpenThread/examples/CLI/SimpleThreadNetwork/RouterNode	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/OpenThread/examples/CLI/ThreadScan	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/OpenThread/examples/CLI/onReceive	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/OpenThread/examples/Native/SimpleThreadNetwork/LeaderNode	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/OpenThread/examples/Native/SimpleThreadNetwork/RouterNode	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Binary_Input_Output	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_CarbonDioxide_Sensor	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Color_Dimmable_Light	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Contact_Switch	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Dimmable_Light	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Electrical_DC_Sensor	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Illuminance_Sensor	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_OTA_Client	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Occupancy_Sensor	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_On_Off_Light	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_PM25_Sensor	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Pressure_Flow_Sensor	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Scan_Networks	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Temp_Hum_Sensor_Sleepy	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Temperature_Sensor	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Vibration_Sensor	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Wind_Speed_Sensor	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/Zigbee/examples/Zigbee_Window_Covering	-	-	-	-	-	-	-	-	0	0	-	-	-	-	-	-
libraries/ESP_HostedOTA/examples/ESP_HostedOTA	-	-	-	-	-	-	-	-	-	-	0	0	-	-	-	-
libraries/ESP_SR/examples/Basic	-	-	-	-	-	-	-	-	-	-	0	0	-	-	-	-
libraries/SD_MMC/examples/SD2USBMSC	-	-	-	-	-	-	-	-	-	-	0	0	-	-	-	-
libraries/USB/examples/CompositeDevice	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/ConsumerControl	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/CustomHIDDevice	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/FirmwareMSC	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/Gamepad	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/HIDVendor	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/Keyboard/KeyboardLogout	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/Keyboard/KeyboardMessage	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/Keyboard/KeyboardReprogram	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/Keyboard/KeyboardSerial	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/KeyboardAndMouseControl	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/MIDI/MidiController	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/MIDI/MidiInterface	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/MIDI/MidiMusicBox	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/MIDI/ReceiveMidi	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/Mouse/ButtonMouseControl	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/SystemControl	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/USBMSC	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/USBSerial	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-
libraries/USB/examples/USBVendor	-	-	-	-	-	-	-	-	-	-	0	0	0	0	-	-

lbernstone · 2026-01-15T02:46:43Z

Looks good. There's still a couple /* remarked functions at the end, and the helper functions are empty, but fairly self-explanatory.

feat(update): Add Doxygen style documentation for the Update class

c80ad8e

me-no-dev added 2 commits January 14, 2026 22:54

fix(update): Revert some changes from AI

69598a5

feat(core): Document verifyOta and verifyRollbackLater

1d2923e

me-no-dev requested a review from a team as a code owner January 14, 2026 21:01

lucasssvaz reviewed Jan 14, 2026

View reviewed changes

cores/esp32/esp32-hal-misc.c Outdated Show resolved Hide resolved

fix(core): Remove unnecessary ifdef

cc0b411

me-no-dev added Status: Review needed Issue or PR is awaiting review Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Jan 19, 2026

ci(pre-commit): Apply automatic fixes

c813e84

me-no-dev merged commit 15ef0aa into master Jan 21, 2026
82 checks passed

me-no-dev deleted the feat/doc_updater branch January 21, 2026 15:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(update): Add Doxygen style documentation for the Update class#12243

feat(update): Add Doxygen style documentation for the Update class#12243
me-no-dev merged 5 commits intomasterfrom
feat/doc_updater

me-no-dev commented Jan 14, 2026

Uh oh!

me-no-dev commented Jan 14, 2026

Uh oh!

github-actions bot commented Jan 14, 2026 •

edited

Loading

Uh oh!

Uh oh!

github-actions bot commented Jan 14, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Jan 14, 2026 •

edited

Loading

Uh oh!

lbernstone commented Jan 15, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

me-no-dev commented Jan 14, 2026

Uh oh!

me-no-dev commented Jan 14, 2026

Uh oh!

github-actions bot commented Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

github-actions bot commented Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Memory usage test (comparing PR against master branch)

Uh oh!

lbernstone commented Jan 15, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Jan 14, 2026 •

edited

Loading

github-actions bot commented Jan 14, 2026 •

edited

Loading

github-actions bot commented Jan 14, 2026 •

edited

Loading