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

Correct the documentation

Browse Source 
- Fix some style issue, typos, and examples
- Follow the variable naming conventions
- Fix tables both in the project and on the webpage

JerryScript-DCO-1.0-Signed-off-by: Zsolt Borbély zsborbely.u-szeged@partner.samsung.com
This commit is contained in:
Zsolt Borbély
2016-08-24 12:52:02 +02:00
parent 48d5eee920
commit e93e32635f
7 changed files with 180 additions and 153 deletions
Download Patch File Download Diff File Expand all files Collapse all files
jerry-core/jerry-api.h
+3 -3
View File
@@ -139,7 +139,7 @@ typedef struct
/**
* Type of an external function handler
*/
typedef jerry_value_t (*jerry_external_handler_t) (const jerry_value_t function_obj_p,
typedef jerry_value_t (*jerry_external_handler_t) (const jerry_value_t function_obj,
const jerry_value_t this_val,
const jerry_value_t args_p[],
const jerry_length_t args_count);
@@ -152,7 +152,7 @@ typedef void (*jerry_object_free_callback_t) (const uintptr_t native_p);
/**
* Function type applied for each data property of an object
*/
typedef bool (*jerry_object_property_foreach_t) (const jerry_value_t property_name_p,
typedef bool (*jerry_object_property_foreach_t) (const jerry_value_t property_name,
const jerry_value_t property_value,
void *user_data_p);
@@ -231,7 +231,7 @@ jerry_value_t jerry_value_to_string (const jerry_value_t);
jerry_value_t jerry_acquire_value (jerry_value_t);
/**
* Relase the referenced values
* Release the referenced values
*/
void jerry_release_value (jerry_value_t);
jerry-core/jerry.c
+9 -9
View File
@@ -196,14 +196,14 @@ jerry_cleanup (void)
* Register external magic string array
*/
void
jerry_register_magic_strings (const jerry_char_ptr_t *ex_str_items, /**< character arrays, representing
* external magic strings' contents */
jerry_register_magic_strings (const jerry_char_ptr_t *ex_str_items_p, /**< character arrays, representing
* external magic strings' contents */
uint32_t count, /**< number of the strings */
const jerry_length_t *str_lengths) /**< lengths of all strings */
const jerry_length_t *str_lengths_p) /**< lengths of all strings */
{
jerry_assert_api_available ();
lit_magic_strings_ex_set ((const lit_utf8_byte_t **) ex_str_items, count, (const lit_utf8_size_t *) str_lengths);
lit_magic_strings_ex_set ((const lit_utf8_byte_t **) ex_str_items_p, count, (const lit_utf8_size_t *) str_lengths_p);
} /* jerry_register_magic_strings */
/**
@@ -236,7 +236,7 @@ jerry_gc (void)
* false - otherwise
*/
bool
jerry_run_simple (const jerry_char_t *script_source, /**< script source */
jerry_run_simple (const jerry_char_t *script_source_p, /**< script source */
size_t script_source_size, /**< script source size */
jerry_init_flag_t flags) /**< combination of Jerry flags */
{
@@ -244,7 +244,7 @@ jerry_run_simple (const jerry_char_t *script_source, /**< script source */
jerry_init (flags);
jerry_value_t parse_ret_val = jerry_parse (script_source, script_source_size, false);
jerry_value_t parse_ret_val = jerry_parse (script_source_p, script_source_size, false);
if (!ECMA_IS_VALUE_ERROR (parse_ret_val))
{
@@ -1695,7 +1695,7 @@ jerry_get_object_native_handle (const jerry_value_t obj_val, /**< object to get
*/
void
jerry_set_object_native_handle (const jerry_value_t obj_val, /**< object to set handle in */
uintptr_t handle, /**< handle value */
uintptr_t handle_p, /**< handle value */
jerry_object_free_callback_t freecb_p) /**< object free callback or NULL */
{
jerry_assert_api_available ();
@@ -1704,7 +1704,7 @@ jerry_set_object_native_handle (const jerry_value_t obj_val, /**< object to set
ecma_create_external_pointer_property (object_p,
ECMA_INTERNAL_PROPERTY_NATIVE_HANDLE,
handle);
handle_p);
if (freecb_p != NULL)
{
@@ -2051,7 +2051,7 @@ jerry_snapshot_set_offsets (uint8_t *buffer_p, /**< buffer */
*
* @return size of snapshot, if it was generated succesfully
* (i.e. there are no syntax errors in source code, buffer size is sufficient,
* and snapshot support is enabled in current configuration through JERRY_ENABLE_SNAPSHOT),
* and snapshot support is enabled in current configuration through JERRY_ENABLE_SNAPSHOT_SAVE),
* 0 - otherwise.
*/
size_t