feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

docs: fix driver sphinx warnings

Browse Source
This commit is contained in:
Michael (XIAO Xufeng)
2022-11-24 15:54:44 +08:00
parent daa4af1b1f
commit 0fcd384677
4 changed files with 6 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
components/driver/include/driver/rmt_encoder.h
View File

@@ -15,10 +15,9 @@
extern "C" { extern "C" {
#endif #endif
/** /** @cond */
* @brief Type of RMT encoder
*/
typedef struct rmt_encoder_t rmt_encoder_t; typedef struct rmt_encoder_t rmt_encoder_t;
/** @endcond */
/** /**
* @brief RMT encoding state * @brief RMT encoding state

2
components/driver/include/driver/spi_master.h
View File

@@ -45,7 +45,9 @@ extern "C"
#define SPI_DEVICE_DDRCLK (1<<7) #define SPI_DEVICE_DDRCLK (1<<7)
#define SPI_DEVICE_NO_RETURN_RESULT (1<<8) ///< Don't return the descriptor to the host on completion (use post_cb to notify instead) #define SPI_DEVICE_NO_RETURN_RESULT (1<<8) ///< Don't return the descriptor to the host on completion (use post_cb to notify instead)
/** @cond */
typedef struct spi_transaction_t spi_transaction_t; typedef struct spi_transaction_t spi_transaction_t;
/** @endcond */
typedef void(*transaction_cb_t)(spi_transaction_t *trans); typedef void(*transaction_cb_t)(spi_transaction_t *trans);
/** /**

2
components/driver/include/driver/spi_slave.h
View File

@@ -25,7 +25,9 @@ extern "C"
#define SPI_SLAVE_BIT_LSBFIRST (SPI_SLAVE_TXBIT_LSBFIRST|SPI_SLAVE_RXBIT_LSBFIRST) ///< Transmit and receive LSB first #define SPI_SLAVE_BIT_LSBFIRST (SPI_SLAVE_TXBIT_LSBFIRST|SPI_SLAVE_RXBIT_LSBFIRST) ///< Transmit and receive LSB first
#define SPI_SLAVE_NO_RETURN_RESULT (1<<2) ///< Don't return the descriptor to the host on completion (use `post_trans_cb` to notify instead) #define SPI_SLAVE_NO_RETURN_RESULT (1<<2) ///< Don't return the descriptor to the host on completion (use `post_trans_cb` to notify instead)
/** @cond */
typedef struct spi_slave_transaction_t spi_slave_transaction_t; typedef struct spi_slave_transaction_t spi_slave_transaction_t;
/** @endcond */
typedef void(*slave_transaction_cb_t)(spi_slave_transaction_t *trans); typedef void(*slave_transaction_cb_t)(spi_slave_transaction_t *trans);
/** /**

6
docs/sphinx-known-warnings.txt
View File

@@ -9,12 +9,6 @@
idf-component-manager.rst: WARNING: Badly formated string substitution: {IDF_TARGET} idf-component-manager.rst: WARNING: Badly formated string substitution: {IDF_TARGET}
esp_ble_mesh_defs.inc:line: WARNING: Duplicate C++ declaration, also defined at api-reference/bluetooth/esp-ble-mesh:line. esp_ble_mesh_defs.inc:line: WARNING: Duplicate C++ declaration, also defined at api-reference/bluetooth/esp-ble-mesh:line.
Declaration is '.. cpp:member:: uint16_t model_id'. Declaration is '.. cpp:member:: uint16_t model_id'.
rmt_encoder.inc:line: WARNING: Duplicate C++ declaration, also defined at api-reference/peripherals/rmt:line.
Declaration is '.. cpp:type:: struct rmt_encoder_t rmt_encoder_t'.
spi_master.inc:line: WARNING: Duplicate C++ declaration, also defined at api-reference/peripherals/spi_master:line.
Declaration is '.. cpp:type:: struct spi_transaction_t spi_transaction_t'.
spi_slave.inc:line: WARNING: Duplicate C++ declaration, also defined at api-reference/peripherals/spi_slave:line.
Declaration is '.. cpp:type:: struct spi_slave_transaction_t spi_slave_transaction_t'.
mqtt_client.inc:line: WARNING: Duplicate C++ declaration, also defined at api-reference/protocols/mqtt:line. mqtt_client.inc:line: WARNING: Duplicate C++ declaration, also defined at api-reference/protocols/mqtt:line.
Declaration is '.. cpp:type:: struct esp_mqtt_event_t esp_mqtt_event_t'. Declaration is '.. cpp:type:: struct esp_mqtt_event_t esp_mqtt_event_t'.
mqtt_client.inc:line: WARNING: Duplicate C++ declaration, also defined at api-reference/protocols/mqtt:line. mqtt_client.inc:line: WARNING: Duplicate C++ declaration, also defined at api-reference/protocols/mqtt:line.