From: Ivan Grokhotkov Date: Wed, 26 Jul 2017 08:26:13 +0000 (+0800) Subject: docs: fix warnings related to SD SPI documentation X-Git-Tag: v3.1-dev~434^2 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=770b9e3b9e03a80d3ba442dbc104f5e0ba530959;p=esp-idf docs: fix warnings related to SD SPI documentation --- diff --git a/docs/Doxyfile b/docs/Doxyfile index e6af25c901..9c04f04900 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -88,6 +88,7 @@ INPUT = \ ../components/sdmmc/include/sdmmc_cmd.h \ ../components/driver/include/driver/sdmmc_host.h \ ../components/driver/include/driver/sdmmc_types.h \ + ../components/driver/include/driver/sdspi_host.h \ ## Non-Volatile Storage ../components/nvs_flash/include/nvs.h \ ../components/nvs_flash/include/nvs_flash.h \ diff --git a/docs/api-reference/storage/sdmmc.rst b/docs/api-reference/storage/sdmmc.rst index ef53263850..ba26b9e16d 100644 --- a/docs/api-reference/storage/sdmmc.rst +++ b/docs/api-reference/storage/sdmmc.rst @@ -104,7 +104,7 @@ SPI controllers accessible via spi_master driver (HSPI, VSPI) can be used to wor SD SPI driver is represented using an ``sdmmc_host_t`` structure initialized using ``SDSPI_HOST_DEFAULT`` macro. For slot initialization, ``SDSPI_SLOT_CONFIG_DEFAULT`` can be used to fill in default pin mapping, which is the same as the pin mapping in SD mode. -SD SPI driver APIs are very similar to SDMMC host APIs. As with the SDMMC host driver, only ``sdspi_host_init``, ``sdspi_host_init_slot``, and ``sdspi_host_deinit`` functions are normally used by the applications. Other functions are called by the protocol level driver via function pointers in ``sdmmc_host_t` structure. +SD SPI driver APIs are very similar to SDMMC host APIs. As with the SDMMC host driver, only ``sdspi_host_init``, ``sdspi_host_init_slot``, and ``sdspi_host_deinit`` functions are normally used by the applications. Other functions are called by the protocol level driver via function pointers in ``sdmmc_host_t`` structure. .. doxygenfunction:: sdspi_host_init @@ -119,7 +119,6 @@ SD SPI driver APIs are very similar to SDMMC host APIs. As with the SDMMC host d .. doxygendefine:: SDSPI_SLOT_NO_WP .. doxygendefine:: SDSPI_SLOT_CONFIG_DEFAULT -.. doxygenfunction:: sdspi_host_set_bus_width .. doxygenfunction:: sdspi_host_set_card_clk .. doxygenfunction:: sdspi_host_do_transaction .. doxygenfunction:: sdspi_host_deinit