API samples

- Logging library
- Virtual file system component

diff --git a/docs/Doxyfile b/docs/Doxyfile
index bb55b8ba399f223c45e02bc8070e75c58ba1626d..9c53aff1f33095afcad5d9f953233df805f96fa4 100644 (file)
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -1,13 +1,22 @@
 PROJECT_NAME = "ESP32 Programming Guide"
-XML_OUTPUT = xml
-GENERATE_LATEX = NO
-GENERATE_MAN = NO
-GENERATE_RTF = NO
-CASE_SENSE_NAMES = NO
-INPUT = ../components/esp32/include/esp_wifi.h ../components/driver/include/driver/gpio.h ../components/esp32/include/rom/gpio.h ../components/bt/include ../components/nvs_flash/include
-RECURSIVE = YES
+
+INPUT = ../components/esp32/include/esp_wifi.h ../components/driver/include/driver ../components/esp32/include/rom/gpio.h ../components/bt/include ../components/nvs_flash/include ../components/log/include ../components/vfs/include
+
+WARN_NO_PARAMDOC       = YES
+
+RECURSIVE              = NO
+CASE_SENSE_NAMES       = NO
+EXTRACT_ALL            = NO
+
+GENERATE_XML           = YES
+XML_OUTPUT             = xml
+
+GENERATE_HTML          = NO
+HAVE_DOT               = NO
+GENERATE_LATEX         = NO
+GENERATE_MAN           = NO
+GENERATE_RTF           = NO
+
 QUIET = YES
-JAVADOC_AUTOBRIEF = YES
-GENERATE_HTML = NO
-GENERATE_XML = YES
-WARN_LOGFILE = "DoxyGenWarningLog.txt"
+WARN_LOGFILE = "doxygen-warning-log.txt"
+

diff --git a/docs/api/bt.rst b/docs/api/bt.rst
index 16f30dc4e6c0f3dd6d4f5ac31df70113913e382a..72ab9fbd12bd8c3a017c6ffc202af992410a47d7 100644 (file)
--- a/docs/api/bt.rst
+++ b/docs/api/bt.rst
@@ -19,7 +19,7 @@ Reference
 Type Definitions
 ^^^^^^^^^^^^^^^^
 
-.. doxygentypedef:: vhci_host_callback
+.. doxygenstruct:: vhci_host_callback
 
 Functions
 ^^^^^^^^^

diff --git a/docs/api/log.rst b/docs/api/log.rst
new file mode 100644 (file)
index 0000000..8e0f2d8
--- /dev/null
+++ b/docs/api/log.rst
@@ -0,0 +1,20 @@
+.. include:: ../../components/log/README.rst
+
+API Reference
+-------------
+
+Enumerations
+^^^^^^^^^^^^
+
+.. doxygenenum:: esp_log_level_t
+
+Functions
+^^^^^^^^^
+
+.. doxygenfunction:: esp_log_level_set
+.. doxygenfunction:: esp_log_set_vprintf
+.. doxygenfunction:: esp_log_write
+
+.. FIXME esp_log_timestamp
+
+

diff --git a/docs/api/nvs.rst b/docs/api/nvs.rst
index 227a1c1f7f6f764143475f9cad1943cac39770cb..fc2bba5a1613a132682bb74fdd99faf337b06d2f 100644 (file)
--- a/docs/api/nvs.rst
+++ b/docs/api/nvs.rst
@@ -1,7 +1,7 @@
 .. include:: ../../components/nvs_flash/README.rst
 
-Reference
----------
+API Reference
+-------------
 
 Enumerations
 ^^^^^^^^^^^^

diff --git a/docs/api/vfs.rst b/docs/api/vfs.rst
new file mode 100644 (file)
index 0000000..97ea1a5
--- /dev/null
+++ b/docs/api/vfs.rst
@@ -0,0 +1,27 @@
+.. include:: ../../components/vfs/README.rst
+
+API Reference
+-------------
+
+Defines
+^^^^^^^
+
+.. doxygendefine:: ESP_VFS_PATH_MAX 
+.. doxygendefine:: ESP_VFS_FLAG_DEFAULT
+.. doxygendefine:: ESP_VFS_FLAG_CONTEXT_PTR 
+
+
+Structures
+^^^^^^^^^^
+
+.. doxygenstruct:: esp_vfs_t
+
+Functions
+^^^^^^^^^
+
+.. doxygenfunction:: esp_vfs_dev_uart_register
+.. doxygenfunction:: esp_vfs_register
+
+
+
+

diff --git a/docs/index.rst b/docs/index.rst
index 9b62885bb1edc06f1b986e94bfed2008f3198f2c..72c5df13f49b09376e8418b81e646f89297f30a5 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -37,7 +37,9 @@ Contents:
    Wi-Fi <api/esp_wifi>
    Bluetooth <api/bt>
    GPIO <api/gpio>
-   NVS <api/nvs>
+   Logging <api/log>
+   Non-volatile storage <api/nvs>
+   Virtual filesystem <api/vfs>
    Template <api/template>
 
 .. toctree::