Merge branch 'doc/add_types_api_ref' into 'master'

doc: add peripheral_types.h as API reference for peripheral docs

Closes DOC-136 and IDF-1673

See merge request espressif/esp-idf!8528

components/soc/include/hal/gpio_types.h

@@ -26,6 +26,8 @@ typedef enum {
     GPIO_PORT_MAX,
 } gpio_port_t;
 
+/** @cond */    //Doxy command to hide preprocessor definitions from docs */
+
 #define GPIO_SEL_0              (BIT(0))                         /*!< Pin 0 selected */
 #define GPIO_SEL_1              (BIT(1))                         /*!< Pin 1 selected */
 #define GPIO_SEL_2              (BIT(2))                         /*!< Pin 2 selected */
@@ -130,6 +132,8 @@ typedef enum {
 #define GPIO_PIN_REG_46          IO_MUX_GPIO46_REG
 #endif
 
+/** @endcond */
+
 typedef enum {
     GPIO_NUM_NC = -1,    /*!< Use to signal not connected to S/W */
     GPIO_NUM_0 = 0,     /*!< GPIO0, input and output */

components/soc/include/hal/spi_types.h

@@ -27,6 +27,8 @@ typedef enum {
     SPI3_HOST=2,    ///< SPI3
 } spi_host_device_t;
 
+/** @cond */    //Doxy command to hide preprocessor definitions from docs */
+
 //alias for different chips
 #ifdef CONFIG_IDF_TARGET_ESP32
 #define SPI_HOST    SPI1_HOST
@@ -38,3 +40,5 @@ typedef enum {
 #define FSPI_HOST   SPI2_HOST
 #define HSPI_HOST   SPI3_HOST
 #endif
+
+/** @endcond */

docs/en/api-reference/peripherals/adc.rst

@@ -246,6 +246,8 @@ ADC driver
 
 .. include-build-file:: inc/adc.inc
 
+.. include-build-file:: inc/adc_types.inc
+
 .. _adc-api-reference-adc-calibration:
 
 ADC Calibration

docs/en/api-reference/peripherals/dac.rst

@@ -44,3 +44,4 @@ e.g.
 2. ``DAC_{IDF_TARGET_DAC_CH_2}_CHANNEL`` is the channel number of GPIO 26 (channel 2).
 
 .. include-build-file:: inc/dac_channel.inc
+.. include-build-file:: inc/dac_types.inc

docs/en/api-reference/peripherals/gpio.rst

@@ -30,9 +30,12 @@ API Reference - Normal GPIO
 ---------------------------
 
 .. include-build-file:: inc/gpio.inc
+.. include-build-file:: inc/gpio_types.inc
 
 API Reference - RTC GPIO
 ------------------------
 
 .. include-build-file:: inc/rtc_io.inc
+.. include-build-file:: inc/rtc_io_types.inc
+
 

docs/en/api-reference/peripherals/i2c.rst

@@ -249,3 +249,4 @@ API Reference
 -------------
 
 .. include-build-file:: inc/i2c.inc
+.. include-build-file:: inc/i2c_types.inc

docs/en/api-reference/peripherals/i2s.rst

@@ -217,4 +217,5 @@ API Reference
 -------------
 
 .. include-build-file:: inc/i2s.inc
+.. include-build-file:: inc/i2s_types.inc
 

docs/en/api-reference/peripherals/ledc.rst

@@ -203,4 +203,5 @@ API Reference
 -------------
 
 .. include-build-file:: inc/ledc.inc
+.. include-build-file:: inc/ledc_types.inc
 

docs/en/api-reference/peripherals/pcnt.rst

@@ -98,4 +98,5 @@ API Reference
 -------------
 
 .. include-build-file:: inc/pcnt.inc
+.. include-build-file:: inc/pcnt_types.inc
 

docs/en/api-reference/peripherals/rmt.rst

@@ -296,4 +296,5 @@ API Reference
 -------------
 
 .. include-build-file:: inc/rmt.inc
+.. include-build-file:: inc/rmt_types.inc
 

docs/en/api-reference/peripherals/sigmadelta.rst

@@ -30,3 +30,4 @@ API Reference
 -------------
 
 .. include-build-file:: inc/sigmadelta.inc
+.. include-build-file:: inc/sigmadelta_types.inc

docs/en/api-reference/peripherals/timer.rst

@@ -108,3 +108,4 @@ API Reference
 -------------
 
 .. include-build-file:: inc/timer.inc
+.. include-build-file:: inc/timer_types.inc

docs/en/api-reference/peripherals/uart.rst

@@ -401,6 +401,7 @@ API Reference
 -------------
 
 .. include-build-file:: inc/uart.inc
+.. include-build-file:: inc/uart_types.inc
 
 
 GPIO Lookup Macros

docs/zh_CN/api-reference/peripherals/ledc.rst

@@ -173,4 +173,5 @@ API 参考
 -------------
 
 .. include-build-file:: inc/ledc.inc
+.. include-build-file:: inc/ledc_types.inc
 

docs/zh_CN/api-reference/peripherals/timer.rst

@@ -105,3 +105,4 @@ API 参考
 -------------
 
 .. include-build-file:: inc/timer.inc
+.. include-build-file:: inc/timer_types.inc