doc: clarify num_symbols in the tx done event data

Closes https://github.com/espressif/esp-idf/issues/10435
2022-12-27 11:36:01 +08:00
parent 77d220c8e8
commit 26467f63cd
2 changed files with 3 additions and 2 deletions
@@ -34,7 +34,8 @@ typedef struct rmt_encoder_t *rmt_encoder_handle_t;
 * @brief Type of RMT TX done event data
 */
 typedef struct {
-    size_t num_symbols; /*!< The number of transmitted RMT symbols (only one round is counted if it's a loop transmission) */
+    size_t num_symbols; /*!< The number of transmitted RMT symbols, including one EOF symbol, which is appended by the driver to mark the end of a transmission.
+                             For a loop transmission, this value only counts for one round. */
 } rmt_tx_done_event_data_t;

 /**