From db0c6d7921ac636439598b5e45391a22b2902bdc Mon Sep 17 00:00:00 2001 From: Krzysztof Date: Wed, 2 Sep 2020 19:57:39 +0800 Subject: [PATCH] docs: Add esp_rom_printf to API Reference --- docs/Doxyfile | 1 + docs/en/api-reference/system/index.rst | 1 + docs/en/api-reference/system/internal-unstable.rst | 10 ++++++++++ docs/zh_CN/api-reference/system/internal-unstable.rst | 1 + 4 files changed, 13 insertions(+) create mode 100644 docs/en/api-reference/system/internal-unstable.rst create mode 100644 docs/zh_CN/api-reference/system/internal-unstable.rst diff --git a/docs/Doxyfile b/docs/Doxyfile index 85c8776756..b62dd4bbf4 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -257,6 +257,7 @@ INPUT = \ $(IDF_PATH)/components/esp_system/include/esp_sleep.h \ ## Logging $(IDF_PATH)/components/log/include/esp_log.h \ + $(IDF_PATH)/components/esp_rom/include/esp_rom_sys.h \ ## Base MAC address ## NOTE: for line below header_file.inc is not used $(IDF_PATH)/components/esp_system/include/esp_system.h \ diff --git a/docs/en/api-reference/system/index.rst b/docs/en/api-reference/system/index.rst index 98c234b4a0..1b3dd5bf68 100644 --- a/docs/en/api-reference/system/index.rst +++ b/docs/en/api-reference/system/index.rst @@ -30,6 +30,7 @@ System API Sleep Modes Watchdogs System Time + Internal and Unstable API Code examples for this API section are provided in the :example:`system` directory of ESP-IDF examples. diff --git a/docs/en/api-reference/system/internal-unstable.rst b/docs/en/api-reference/system/internal-unstable.rst new file mode 100644 index 0000000000..c5b3d9491e --- /dev/null +++ b/docs/en/api-reference/system/internal-unstable.rst @@ -0,0 +1,10 @@ +Internal and Unstable APIs +========================== + +This section is listing some APIs that are internal or likely to be changed or removed in the next releases of ESP-IDF. + + +API Reference +------------- + +.. include-build-file:: inc/esp_rom_sys.inc diff --git a/docs/zh_CN/api-reference/system/internal-unstable.rst b/docs/zh_CN/api-reference/system/internal-unstable.rst new file mode 100644 index 0000000000..fca9093b80 --- /dev/null +++ b/docs/zh_CN/api-reference/system/internal-unstable.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/internal-unstable.rst