Skip to content

Commit f6eac3a

Browse files
authored
Add notes to jerry_create_undefined, jerry_create_null and jerry_create_boolean (#4790)
JerryScript-DCO-1.0-Signed-off-by: Mate Dabis [email protected]
1 parent c696bc9 commit f6eac3a

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
@@ -7092,6 +7092,10 @@ jerry_create_shared_arraybuffer_external (const jerry_length_t size
70927092

70937093
Create a jerry_value_t representing a boolean value from the given boolean parameter.
70947094

7095+
*Notes*:
7096+
- The boolean values (true/false) are fixed constants. Their values can be copied any number of times without calling
7097+
[jerry_acquire_value](#jerry_acquire_value), and freeing it with [jerry_release_value](#jerry_release_value) is optional.
7098+
70957099
**Prototype**
70967100

70977101
```c
@@ -7460,6 +7464,10 @@ jerry_create_number_nan (void);
74607464

74617465
Creates and returns a `jerry_value_t` with type null object.
74627466

7467+
*Notes*:
7468+
- The null value is a fixed constant. Its value can be copied any number of times without calling
7469+
[jerry_acquire_value](#jerry_acquire_value), and freeing it with [jerry_release_value](#jerry_release_value) is optional.
7470+
74637471
**Prototype**
74647472

74657473
```c
@@ -8398,6 +8406,10 @@ main (void)
83988406

83998407
Creates a `jerry_value_t` representing an undefined value.
84008408

8409+
*Notes*:
8410+
- 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.
8411+
8412+
84018413
**Prototype**
84028414

84038415
```c

0 commit comments

Comments
 (0)