alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'contrib/github_pr_8825' into 'master'

Browse Source 
fix small typos in the comments (documentation) (GitHub PR)

Closes IDFGH-7231

See merge request espressif/esp-idf!17890
This commit is contained in:
morris 2022-04-25 15:39:31 +08:00
commit 017f35a357
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
components/driver/include/driver/rmt.h
View File

@ -44,7 +44,7 @@ typedef struct {
uint32_t duration1 : 15; /*!< Duration of level1 */ uint32_t duration1 : 15; /*!< Duration of level1 */
uint32_t level1 : 1; /*!< Level of the second part */ uint32_t level1 : 1; /*!< Level of the second part */
}; };
uint32_t val; /*!< Equivelent unsigned value for the RMT item */ uint32_t val; /*!< Equivalent unsigned value for the RMT item */
}; };
} rmt_item32_t; } rmt_item32_t;
@ -494,7 +494,7 @@ esp_err_t rmt_rx_memory_reset(rmt_channel_t channel);
/** /**
* @brief Set RMT memory owner. * @brief Set RMT memory owner.
* @note Setting memroy is only valid for RX channel. * @note Setting memory is only valid for RX channel.
* *
* @param channel RMT channel * @param channel RMT channel
* @param owner To set when the transmitter or receiver can process the memory of channel. * @param owner To set when the transmitter or receiver can process the memory of channel.
@ -863,7 +863,7 @@ esp_err_t rmt_get_ringbuf_handle(rmt_channel_t channel, RingbufHandle_t *buf_han
/** /**
* @brief Init rmt translator and register user callback. * @brief Init rmt translator and register user callback.
* The callback will convert the raw data that needs to be sent to rmt format. * The callback will convert the raw data that needs to be sent to rmt format.
* If a channel is initialized more than once, tha user callback will be replaced by the later. * If a channel is initialized more than once, the user callback will be replaced by the later.
* *
* @param channel RMT channel . * @param channel RMT channel .
* @param fn Point to the data conversion function. * @param fn Point to the data conversion function.
@ -892,7 +892,7 @@ esp_err_t rmt_translator_set_context(rmt_channel_t channel, void *context);
* @note This API must be invoked in the RMT translator callback function, * @note This API must be invoked in the RMT translator callback function,
* and the first argument must be the actual parameter 'item_num' you got in that callback function. * and the first argument must be the actual parameter 'item_num' you got in that callback function.
* *
* @param item_num Address of the memory which contains the number of translated items (It's from driver's internal memroy) * @param item_num Address of the memory which contains the number of translated items (It's from driver's internal memory)
* @param context Returned User context * @param context Returned User context
* *
* @return * @return