API samples

- Logging library
- Virtual file system component

docs/Doxyfile

@@ -1,13 +1,22 @@
 PROJECT_NAME = "ESP32 Programming Guide"
-XML_OUTPUT = xml
+
-GENERATE_LATEX = NO
+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
-GENERATE_MAN = NO
+
-GENERATE_RTF = NO
+WARN_NO_PARAMDOC	= YES
-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		= NO
-RECURSIVE = YES
+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
+WARN_LOGFILE = "doxygen-warning-log.txt"
-GENERATE_HTML = NO
+
-GENERATE_XML = YES
-WARN_LOGFILE = "DoxyGenWarningLog.txt"

docs/api/bt.rst

@@ -19,7 +19,7 @@ Reference
 Type Definitions
 ^^^^^^^^^^^^^^^^
 
-.. doxygentypedef:: vhci_host_callback
+.. doxygenstruct:: vhci_host_callback
 
 Functions
 ^^^^^^^^^

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
+
+

docs/api/nvs.rst

@@ -1,7 +1,7 @@
 .. include:: ../../components/nvs_flash/README.rst
 
-Reference
+API Reference
----------
+-------------
 
 Enumerations
 ^^^^^^^^^^^^

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
+
+
+
+

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::