Skip to content

Commit fc995bb

Browse files
committed
Add notes to jerry_create_undefined, jerry_create_null and jerry_create_boolean
JerryScript-DCO-1.0-Signed-off-by: Mate Dabis [email protected]
1 parent 54b1a3c commit fc995bb

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/02.API-REFERENCE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6870,6 +6870,10 @@ jerry_create_shared_arraybuffer_external (const jerry_length_t size
68706870

68716871
Create a jerry_value_t representing a boolean value from the given boolean parameter.
68726872

6873+
*Notes*:
6874+
- The boolean values (true/false) are fixed constants. Their values can be copied any number of times without calling
6875+
[jerry_acquire_value](#jerry_acquire_value), and freeing it with [jerry_release_value](#jerry_release_value) is optional.
6876+
68736877
**Prototype**
68746878

68756879
```c
@@ -7238,6 +7242,10 @@ jerry_create_number_nan (void);
72387242

72397243
Creates and returns a `jerry_value_t` with type null object.
72407244

7245+
*Notes*:
7246+
- The null value is a fixed constant. Its value can be copied any number of times without calling
7247+
[jerry_acquire_value](#jerry_acquire_value), and freeing it with [jerry_release_value](#jerry_release_value) is optional.
7248+
72417249
**Prototype**
72427250

72437251
```c
@@ -8176,6 +8184,10 @@ main (void)
81768184

81778185
Creates a `jerry_value_t` representing an undefined value.
81788186

8187+
*Notes*:
8188+
- 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.
8189+
8190+
81798191
**Prototype**
81808192

81818193
```c

0 commit comments

Comments
 (0)