From 00a7485adc99e525094c617737c0c25d88dade41 Mon Sep 17 00:00:00 2001 From: Vincent Date: Tue, 16 Jan 2024 15:05:47 +0100 Subject: [PATCH 1/2] Added isKey and getType methods to the documentation (#9111) --- docs/source/api/preferences.rst | 39 +++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/docs/source/api/preferences.rst b/docs/source/api/preferences.rst index 33fb2b6042e..aae81506aa1 100644 --- a/docs/source/api/preferences.rst +++ b/docs/source/api/preferences.rst @@ -177,6 +177,45 @@ Arduino-esp32 Preferences API **Note** * A message providing the reason for a failed call is sent to the arduino-esp32 ``log_e`` facility. + + +``isKey`` +************* + + Check if a key-value pair from the currently open namespace exists. + + .. code-block:: arduino + + bool isKey(const char * key) + .. + + **Parameters** + * ``key`` (Required) + - the name of the key to be checked. + + **Returns** + * ``true`` if key-value pair exists; ``false`` otherwise. + + **Note** + * Attempting to check a key without a namespace being open will return false. + + +``getType`` +************* + + Returns the type of a key-value pair from the currently open namespace. + + .. code-block:: arduino + + PreferenceType getType(const char * key) + .. + + **Parameters** + * ``key`` (Required) + - the name of the key to be checked. + + **Returns** + * PreferenceType element contaning the type of the key-value pair or PT_INVALID on error. ``putChar, putUChar`` From 96446e0ccd51c8633a5a1a5a8967f1c7abdf075d Mon Sep 17 00:00:00 2001 From: Vincent Date: Fri, 19 Jan 2024 11:53:39 +0100 Subject: [PATCH 2/2] Removed duplicated getType documentation. --- docs/source/api/preferences.rst | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/docs/source/api/preferences.rst b/docs/source/api/preferences.rst index aae81506aa1..83ca6d820e9 100644 --- a/docs/source/api/preferences.rst +++ b/docs/source/api/preferences.rst @@ -198,24 +198,6 @@ Arduino-esp32 Preferences API **Note** * Attempting to check a key without a namespace being open will return false. - - -``getType`` -************* - - Returns the type of a key-value pair from the currently open namespace. - - .. code-block:: arduino - - PreferenceType getType(const char * key) - .. - - **Parameters** - * ``key`` (Required) - - the name of the key to be checked. - - **Returns** - * PreferenceType element contaning the type of the key-value pair or PT_INVALID on error. ``putChar, putUChar``