From fc995bb8b6f87e6142073d71a7ddf02ba9b8455f Mon Sep 17 00:00:00 2001 From: Mate Dabis Date: Tue, 5 Oct 2021 10:52:48 +0200 Subject: [PATCH] Add notes to jerry_create_undefined, jerry_create_null and jerry_create_boolean JerryScript-DCO-1.0-Signed-off-by: Mate Dabis mdabis@inf.u-szeged.hu --- docs/02.API-REFERENCE.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/02.API-REFERENCE.md b/docs/02.API-REFERENCE.md index b3bb9fe9d8..391cb60090 100644 --- a/docs/02.API-REFERENCE.md +++ b/docs/02.API-REFERENCE.md @@ -6870,6 +6870,10 @@ jerry_create_shared_arraybuffer_external (const jerry_length_t size Create a jerry_value_t representing a boolean value from the given boolean parameter. +*Notes*: +- The boolean values (true/false) are fixed constants. Their values can be copied any number of times without calling + [jerry_acquire_value](#jerry_acquire_value), and freeing it with [jerry_release_value](#jerry_release_value) is optional. + **Prototype** ```c @@ -7238,6 +7242,10 @@ jerry_create_number_nan (void); Creates and returns a `jerry_value_t` with type null object. +*Notes*: +- The null value is a fixed constant. Its value can be copied any number of times without calling + [jerry_acquire_value](#jerry_acquire_value), and freeing it with [jerry_release_value](#jerry_release_value) is optional. + **Prototype** ```c @@ -8176,6 +8184,10 @@ main (void) Creates a `jerry_value_t` representing an undefined value. +*Notes*: +- The undefined value is a fixed constant. Its value can be copied any number of times without calling [jerry_acquire_value](#jerry_acquire_value), and freeing it with [jerry_release_value](#jerry_release_value) is optional. + + **Prototype** ```c