Draft of non-volatile storage component documentation

diff --git a/docs/Doxyfile b/docs/Doxyfile
index f905de74ce0955137c0f97345681937622fbce19..bb55b8ba399f223c45e02bc8070e75c58ba1626d 100644 (file)
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -4,7 +4,7 @@ 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/bt.h
+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
 QUIET = YES
 JAVADOC_AUTOBRIEF = YES

diff --git a/docs/api/nvs.rst b/docs/api/nvs.rst
new file mode 100644 (file)
index 0000000..227a1c1
--- /dev/null
+++ b/docs/api/nvs.rst
@@ -0,0 +1,68 @@
+.. include:: ../../components/nvs_flash/README.rst
+
+Reference
+---------
+
+Enumerations
+^^^^^^^^^^^^
+
+.. doxygenenum:: nvs_open_mode
+
+Functions
+^^^^^^^^^
+
+.. doxygenfunction:: nvs_flash_init
+.. doxygenfunction:: nvs_flash_init_custom
+
+.. doxygenfunction:: nvs_open
+
+*Note: the following nvs_set_X function are "the same" except the data type accepted*
+
+.. doxygenfunction:: nvs_set_i8
+.. doxygenfunction:: nvs_set_u8
+.. doxygenfunction:: nvs_set_i16
+.. doxygenfunction:: nvs_set_u16
+.. doxygenfunction:: nvs_set_i32
+.. doxygenfunction:: nvs_set_u32
+.. doxygenfunction:: nvs_set_i64
+.. doxygenfunction:: nvs_set_u64
+.. doxygenfunction:: nvs_set_str
+.. doxygenfunction:: nvs_set_blob
+
+*Note: the following nvs_get_X functions are "the same" except the data type returned*
+
+.. doxygenfunction:: nvs_get_i8
+.. doxygenfunction:: nvs_get_u8
+.. doxygenfunction:: nvs_get_i16
+.. doxygenfunction:: nvs_get_u16
+.. doxygenfunction:: nvs_get_i32
+.. doxygenfunction:: nvs_get_u32
+.. doxygenfunction:: nvs_get_i64
+.. doxygenfunction:: nvs_get_u64
+.. doxygenfunction:: nvs_get_str
+.. doxygenfunction:: nvs_get_blob
+
+.. doxygenfunction:: nvs_erase_key
+.. doxygenfunction:: nvs_erase_all
+.. doxygenfunction:: nvs_commit
+.. doxygenfunction:: nvs_close
+
+Error codes
+^^^^^^^^^^^
+
+.. doxygendefine:: ESP_ERR_NVS_BASE
+.. doxygendefine:: ESP_ERR_NVS_NOT_INITIALIZED
+.. doxygendefine:: ESP_ERR_NVS_NOT_FOUND
+.. doxygendefine:: ESP_ERR_NVS_TYPE_MISMATCH
+.. doxygendefine:: ESP_ERR_NVS_READ_ONLY
+.. doxygendefine:: ESP_ERR_NVS_NOT_ENOUGH_SPACE
+.. doxygendefine:: ESP_ERR_NVS_INVALID_NAME
+.. doxygendefine:: ESP_ERR_NVS_INVALID_HANDLE
+.. doxygendefine:: ESP_ERR_NVS_REMOVE_FAILED
+.. doxygendefine:: ESP_ERR_NVS_KEY_TOO_LONG
+.. doxygendefine:: ESP_ERR_NVS_PAGE_FULL
+.. doxygendefine:: ESP_ERR_NVS_INVALID_STATE
+.. doxygendefine:: ESP_ERR_NVS_INVALID_LENGTH
+
+
+

diff --git a/docs/api/template.rst b/docs/api/template.rst
index 8b1dfd4c50ce7b27770900d8554c797b6b378006..0f2623c47fb86b6120bd60820fa9a88f158fd75c 100644 (file)
--- a/docs/api/template.rst
+++ b/docs/api/template.rst
@@ -6,6 +6,15 @@ Overview
 
 INSTRUCTIONS: Provide overview where and how this API may be used. For large number of functions, break down description into groups.
 
+Use the folowing heading levels:
+
+* # with overline, for parts
+* \* with overline, for chapters
+* =, for sections
+* -, for subsections
+* ^, for subsubsections
+* ", for paragraphs
+
 
 Application Example
 -------------------

diff --git a/docs/index.rst b/docs/index.rst
index 5c4d7025c652891a7c36ed1328e086fee54a314d..9b62885bb1edc06f1b986e94bfed2008f3198f2c 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -37,6 +37,7 @@ Contents:
    Wi-Fi <api/esp_wifi>
    Bluetooth <api/bt>
    GPIO <api/gpio>
+   NVS <api/nvs>
    Template <api/template>
 
 .. toctree::