YourWishes/jerryscript
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix typos in the API documentation. (#2423)

Browse Source 
JerryScript-DCO-1.0-Signed-off-by: Robert Fancsik frobert@inf.u-szeged.hu
This commit is contained in:
Robert Fancsik
2018-07-13 09:36:21 +02:00
committed by László Langó
parent 857ba99694
commit 0ca04376a5
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/02.API-REFERENCE.md
+5 -5
View File
@@ -362,7 +362,7 @@ typedef void (*jerry_object_native_free_callback_t) (void *native_p);
**Summary** **Summary**
The type infomation of the native pointer. The type information of the native pointer.
It includes the free callback that will be called when associated JavaScript object is garbage collected. It can be left NULL in case it is not needed. It includes the free callback that will be called when associated JavaScript object is garbage collected. It can be left NULL in case it is not needed.
Typically, one would create a `static const jerry_object_native_info_t` for Typically, one would create a `static const jerry_object_native_info_t` for
@@ -4505,7 +4505,7 @@ The pointer and the type information are previously associated with the object b
and dereferencing `out_native_pointer_p`. and dereferencing `out_native_pointer_p`.
*Note*: `out_native_pointer_p` and `out_native_info_p` can be NULL, and it means the *Note*: `out_native_pointer_p` and `out_native_info_p` can be NULL, and it means the
caller doesn't want to get the native_pointer or type infomation. caller doesn't want to get the native_pointer or type information.
**Prototype** **Prototype**
@@ -4518,7 +4518,7 @@ jerry_get_object_native_pointer (const jerry_value_t obj_val,
- `obj_val` - object value to get native pointer from. - `obj_val` - object value to get native pointer from.
- `out_native_pointer_p` - native pointer (output parameter). - `out_native_pointer_p` - native pointer (output parameter).
- `out_native_info_p` - native pointer's type infomation (output parameter). - `out_native_info_p` - native pointer's type information (output parameter).
- return value - return value
- true, if there is native pointer associated with the object - true, if there is native pointer associated with the object
- false, otherwise - false, otherwise
@@ -4615,7 +4615,7 @@ jerry_set_object_native_pointer (const jerry_value_t obj_val,
- `obj_val` - object to set native pointer in. - `obj_val` - object to set native pointer in.
- `native_p` - native pointer. - `native_p` - native pointer.
- `info_p` - native pointer's type infomation or NULL. When used, this should - `info_p` - native pointer's type information or NULL. When used, this should
be a long-lived pointer, usually a pointer to a be a long-lived pointer, usually a pointer to a
`static const jerry_object_native_info_t` makes most sense. `static const jerry_object_native_info_t` makes most sense.
@@ -4773,7 +4773,7 @@ bool jerry_objects_foreach_by_native_info (const jerry_object_native_info_t *nat
void *user_data_p); void *user_data_p);
``` ```
- `native_info_p` - native pointer's type infomation. - `native_info_p` - native pointer's type information.
- return value - return value
- `true`, if the search function terminated the traversal by returning `false` - `true`, if the search function terminated the traversal by returning `false`
- `false`, if the end of the list of objects was reached - `false`, if the end of the list of objects was reached