]> granicus.if.org Git - esp-idf/commitdiff
docs: fix warnings related to SD SPI documentation
authorIvan Grokhotkov <ivan@espressif.com>
Wed, 26 Jul 2017 08:26:13 +0000 (16:26 +0800)
committerIvan Grokhotkov <ivan@espressif.com>
Thu, 27 Jul 2017 12:43:26 +0000 (20:43 +0800)
docs/Doxyfile
docs/api-reference/storage/sdmmc.rst

index e6af25c901967a24defcf1889377c9fd0a3d63d7..9c04f04900ae8e4399a5a3601ba7549c729879a6 100644 (file)
@@ -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 \
index ef532638506f3805fa9259aa5c56721073796047..ba26b9e16d3e852fa747470a68eab108f306cb11 100644 (file)
@@ -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