From 0fcd3846773be7247e0a45fc149b205c88e4aa20 Mon Sep 17 00:00:00 2001
From: "Michael (XIAO Xufeng)" <xiaoxufeng@espressif.com>
Date: Thu, 24 Nov 2022 15:54:44 +0800
Subject: [PATCH] docs: fix driver sphinx warnings

---
 components/driver/include/driver/rmt_encoder.h | 5 ++---
 components/driver/include/driver/spi_master.h  | 2 ++
 components/driver/include/driver/spi_slave.h   | 2 ++
 docs/sphinx-known-warnings.txt                 | 6 ------
 4 files changed, 6 insertions(+), 9 deletions(-)

diff --git a/components/driver/include/driver/rmt_encoder.h b/components/driver/include/driver/rmt_encoder.h
index 2d3457b684..6fdccf8a81 100644
--- a/components/driver/include/driver/rmt_encoder.h
+++ b/components/driver/include/driver/rmt_encoder.h
@@ -15,10 +15,9 @@
 extern "C" {
 #endif
 
-/**
- * @brief Type of RMT encoder
- */
+/** @cond */
 typedef struct rmt_encoder_t rmt_encoder_t;
+/** @endcond */
 
 /**
  * @brief RMT encoding state
diff --git a/components/driver/include/driver/spi_master.h b/components/driver/include/driver/spi_master.h
index 07d38d1625..d6f42629ac 100644
--- a/components/driver/include/driver/spi_master.h
+++ b/components/driver/include/driver/spi_master.h
@@ -45,7 +45,9 @@ extern "C"
 #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)
 
+/** @cond */
 typedef struct spi_transaction_t spi_transaction_t;
+/** @endcond */
 typedef void(*transaction_cb_t)(spi_transaction_t *trans);
 
 /**
diff --git a/components/driver/include/driver/spi_slave.h b/components/driver/include/driver/spi_slave.h
index a0a1cd4c2f..dbbfc1fb20 100644
--- a/components/driver/include/driver/spi_slave.h
+++ b/components/driver/include/driver/spi_slave.h
@@ -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_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;
+/** @endcond */
 typedef void(*slave_transaction_cb_t)(spi_slave_transaction_t *trans);
 
 /**
diff --git a/docs/sphinx-known-warnings.txt b/docs/sphinx-known-warnings.txt
index 321d1ac86e..7ae9c66e6c 100644
--- a/docs/sphinx-known-warnings.txt
+++ b/docs/sphinx-known-warnings.txt
@@ -9,12 +9,6 @@
 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.
 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.
 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.