From 66bffc39ba2ab789a2d99ca05d2eac22c6537cea Mon Sep 17 00:00:00 2001 From: Levente Orban Date: Fri, 17 Mar 2017 11:48:43 +0100 Subject: [PATCH] Style fix: return value comments JerryScript-DCO-1.0-Signed-off-by: Levente Orban orbanl@inf.u-szeged.hu --- .../base/ecma-helpers-external-pointers.c | 4 +-- jerry-core/ecma/base/ecma-helpers-number.c | 2 +- jerry-core/ecma/base/ecma-helpers-string.c | 6 ++-- jerry-core/ecma/base/ecma-helpers-value.c | 34 +++++++++---------- jerry-core/ecma/base/ecma-helpers.c | 6 ++-- jerry-core/ecma/base/ecma-literal-storage.c | 12 +++---- .../ecma/builtin-objects/ecma-builtins.c | 4 +-- jerry-core/ecma/operations/ecma-comparison.c | 4 +-- jerry-core/ecma/operations/ecma-conversion.c | 6 ++-- .../ecma/operations/ecma-function-object.c | 8 ++--- jerry-core/ecma/operations/ecma-objects.c | 20 +++++------ jerry-core/jerry-snapshot.c | 10 +++--- jerry-core/jerry.c | 26 +++++++------- jerry-core/lit/lit-char-helpers.c | 12 +++---- jerry-core/lit/lit-strings.c | 2 +- jerry-core/parser/regexp/re-parser.c | 8 ++--- jerry-core/vm/vm-stack.c | 4 +-- jerry-core/vm/vm.c | 8 ++--- jerry-main/main-unix.c | 2 +- targets/default/jerry-port-default-fatal.c | 2 +- 20 files changed, 90 insertions(+), 90 deletions(-) diff --git a/jerry-core/ecma/base/ecma-helpers-external-pointers.c b/jerry-core/ecma/base/ecma-helpers-external-pointers.c index 6095635918..1e176a0a0a 100644 --- a/jerry-core/ecma/base/ecma-helpers-external-pointers.c +++ b/jerry-core/ecma/base/ecma-helpers-external-pointers.c @@ -33,7 +33,7 @@ * - LIT_INTERNAL_MAGIC_STRING_FREE_CALLBACK * * @return true - if property was just created with specified value, - * false - otherwise, if property existed before the call, it's value was updated. + * false - otherwise, if property existed before the call, it's value was updated */ bool ecma_create_external_pointer_property (ecma_object_t *obj_p, /**< object to create property in */ @@ -100,7 +100,7 @@ ecma_create_external_pointer_property (ecma_object_t *obj_p, /**< object to crea * - LIT_INTERNAL_MAGIC_STRING_FREE_CALLBACK * * @return true - if property exists and it's value is returned through out_pointer_p, - * false - otherwise (value returned through out_pointer_p is NULL). + * false - otherwise (value returned through out_pointer_p is NULL) */ bool ecma_get_external_pointer_value (ecma_object_t *obj_p, /**< object to get property value from */ diff --git a/jerry-core/ecma/base/ecma-helpers-number.c b/jerry-core/ecma/base/ecma-helpers-number.c index 22b21e6aab..b1988b1a4d 100644 --- a/jerry-core/ecma/base/ecma-helpers-number.c +++ b/jerry-core/ecma/base/ecma-helpers-number.c @@ -329,7 +329,7 @@ ecma_number_is_zero (ecma_number_t num) /**< ecma-number */ * * @return true - if biased exponent is filled with 1 bits and * fraction is filled with zero bits, - * false - otherwise. + * false - otherwise */ bool ecma_number_is_infinity (ecma_number_t num) /**< ecma-number */ diff --git a/jerry-core/ecma/base/ecma-helpers-string.c b/jerry-core/ecma/base/ecma-helpers-string.c index 6aab60da86..582c534d2d 100644 --- a/jerry-core/ecma/base/ecma-helpers-string.c +++ b/jerry-core/ecma/base/ecma-helpers-string.c @@ -1543,7 +1543,7 @@ ecma_string_compare_to_property_name (ecma_property_t property, /**< property na * ecma_compare_ecma_strings * * @return true - if strings are equal; - * false - otherwise. + * false - otherwise */ static bool __attr_noinline___ ecma_compare_ecma_strings_longpath (const ecma_string_t *string1_p, /* ecma-string */ @@ -1583,7 +1583,7 @@ ecma_compare_ecma_strings_longpath (const ecma_string_t *string1_p, /* ecma-stri * Compare ecma-string to ecma-string * * @return true - if strings are equal; - * false - otherwise. + * false - otherwise */ inline bool __attr_always_inline___ ecma_compare_ecma_strings (const ecma_string_t *string1_p, /* ecma-string */ @@ -1625,7 +1625,7 @@ ecma_compare_ecma_strings (const ecma_string_t *string1_p, /* ecma-string */ * - first string is prefix of second or is lexicographically less than second. * * @return true - if first string is less than second string, - * false - otherwise. + * false - otherwise */ bool ecma_compare_ecma_strings_relational (const ecma_string_t *string1_p, /**< ecma-string */ diff --git a/jerry-core/ecma/base/ecma-helpers-value.c b/jerry-core/ecma/base/ecma-helpers-value.c index 2108f739b3..d0a88facc1 100644 --- a/jerry-core/ecma/base/ecma-helpers-value.c +++ b/jerry-core/ecma/base/ecma-helpers-value.c @@ -115,7 +115,7 @@ ecma_get_pointer_from_ecma_value (ecma_value_t value) /**< value */ * Check if the value is direct ecma-value. * * @return true - if the value is a direct value, - * false - otherwise. + * false - otherwise */ inline bool __attr_pure___ __attr_always_inline___ ecma_is_value_direct (ecma_value_t value) /**< ecma value */ @@ -127,7 +127,7 @@ ecma_is_value_direct (ecma_value_t value) /**< ecma value */ * Check if the value is simple ecma-value. * * @return true - if the value is a simple value, - * false - otherwise. + * false - otherwise */ inline bool __attr_pure___ __attr_always_inline___ ecma_is_value_simple (ecma_value_t value) /**< ecma value */ @@ -139,7 +139,7 @@ ecma_is_value_simple (ecma_value_t value) /**< ecma value */ * Check whether the value is a given simple value. * * @return true - if the value is equal to the given simple value, - * false - otherwise. + * false - otherwise */ static inline bool __attr_pure___ __attr_always_inline___ ecma_is_value_equal_to_simple_value (ecma_value_t value, /**< ecma value */ @@ -152,7 +152,7 @@ ecma_is_value_equal_to_simple_value (ecma_value_t value, /**< ecma value */ * Check if the value is empty. * * @return true - if the value contains implementation-defined empty simple value, - * false - otherwise. + * false - otherwise */ inline bool __attr_pure___ __attr_always_inline___ ecma_is_value_empty (ecma_value_t value) /**< ecma value */ @@ -164,7 +164,7 @@ ecma_is_value_empty (ecma_value_t value) /**< ecma value */ * Check if the value is undefined. * * @return true - if the value contains ecma-undefined simple value, - * false - otherwise. + * false - otherwise */ inline bool __attr_pure___ __attr_always_inline___ ecma_is_value_undefined (ecma_value_t value) /**< ecma value */ @@ -176,7 +176,7 @@ ecma_is_value_undefined (ecma_value_t value) /**< ecma value */ * Check if the value is null. * * @return true - if the value contains ecma-null simple value, - * false - otherwise. + * false - otherwise */ inline bool __attr_pure___ __attr_always_inline___ ecma_is_value_null (ecma_value_t value) /**< ecma value */ @@ -188,7 +188,7 @@ ecma_is_value_null (ecma_value_t value) /**< ecma value */ * Check if the value is boolean. * * @return true - if the value contains ecma-true or ecma-false simple values, - * false - otherwise. + * false - otherwise */ inline bool __attr_pure___ __attr_always_inline___ ecma_is_value_boolean (ecma_value_t value) /**< ecma value */ @@ -200,7 +200,7 @@ ecma_is_value_boolean (ecma_value_t value) /**< ecma value */ * Check if the value is true. * * @return true - if the value contains ecma-true simple value, - * false - otherwise. + * false - otherwise */ inline bool __attr_pure___ __attr_always_inline___ ecma_is_value_true (ecma_value_t value) /**< ecma value */ @@ -212,7 +212,7 @@ ecma_is_value_true (ecma_value_t value) /**< ecma value */ * Check if the value is false. * * @return true - if the value contains ecma-false simple value, - * false - otherwise. + * false - otherwise */ inline bool __attr_pure___ __attr_always_inline___ ecma_is_value_false (ecma_value_t value) /**< ecma value */ @@ -224,7 +224,7 @@ ecma_is_value_false (ecma_value_t value) /**< ecma value */ * Check if the value is not found. * * @return true - if the value contains ecma-not-found simple value, - * false - otherwise. + * false - otherwise */ inline bool __attr_pure___ __attr_always_inline___ ecma_is_value_found (ecma_value_t value) /**< ecma value */ @@ -236,7 +236,7 @@ ecma_is_value_found (ecma_value_t value) /**< ecma value */ * Check if the value is array hole. * * @return true - if the value contains ecma-array-hole simple value, - * false - otherwise. + * false - otherwise */ inline bool __attr_pure___ __attr_always_inline___ ecma_is_value_array_hole (ecma_value_t value) /**< ecma value */ @@ -248,7 +248,7 @@ ecma_is_value_array_hole (ecma_value_t value) /**< ecma value */ * Check if the value is integer ecma-number. * * @return true - if the value contains an integer ecma-number value, - * false - otherwise. + * false - otherwise */ inline bool __attr_pure___ __attr_always_inline___ ecma_is_value_integer_number (ecma_value_t value) /**< ecma value */ @@ -260,7 +260,7 @@ ecma_is_value_integer_number (ecma_value_t value) /**< ecma value */ * Check if both values are integer ecma-numbers. * * @return true - if both values contain integer ecma-number values, - * false - otherwise. + * false - otherwise */ inline bool __attr_pure___ __attr_always_inline___ ecma_are_values_integer_numbers (ecma_value_t first_value, /**< first ecma value */ @@ -276,7 +276,7 @@ ecma_are_values_integer_numbers (ecma_value_t first_value, /**< first ecma value * Check if the value is floating-point ecma-number. * * @return true - if the value contains a floating-point ecma-number value, - * false - otherwise. + * false - otherwise */ inline bool __attr_pure___ __attr_always_inline___ ecma_is_value_float_number (ecma_value_t value) /**< ecma value */ @@ -288,7 +288,7 @@ ecma_is_value_float_number (ecma_value_t value) /**< ecma value */ * Check if the value is ecma-number. * * @return true - if the value contains ecma-number value, - * false - otherwise. + * false - otherwise */ inline bool __attr_pure___ __attr_always_inline___ ecma_is_value_number (ecma_value_t value) /**< ecma value */ @@ -301,7 +301,7 @@ ecma_is_value_number (ecma_value_t value) /**< ecma value */ * Check if the value is ecma-string. * * @return true - if the value contains ecma-string value, - * false - otherwise. + * false - otherwise */ inline bool __attr_pure___ __attr_always_inline___ ecma_is_value_string (ecma_value_t value) /**< ecma value */ @@ -313,7 +313,7 @@ ecma_is_value_string (ecma_value_t value) /**< ecma value */ * Check if the value is object. * * @return true - if the value contains object value, - * false - otherwise. + * false - otherwise */ inline bool __attr_pure___ __attr_always_inline___ ecma_is_value_object (ecma_value_t value) /**< ecma value */ diff --git a/jerry-core/ecma/base/ecma-helpers.c b/jerry-core/ecma/base/ecma-helpers.c index 4d9e93295f..4281e8c76c 100644 --- a/jerry-core/ecma/base/ecma-helpers.c +++ b/jerry-core/ecma/base/ecma-helpers.c @@ -1117,7 +1117,7 @@ ecma_set_named_accessor_property_setter (ecma_object_t *object_p, /**< the prope * Get property's 'Writable' attribute value * * @return true - property is writable, - * false - otherwise. + * false - otherwise */ inline bool __attr_always_inline___ ecma_is_property_writable (ecma_property_t property) /**< property */ @@ -1151,7 +1151,7 @@ ecma_set_property_writable_attr (ecma_property_t *property_p, /**< [in,out] prop * Get property's 'Enumerable' attribute value * * @return true - property is enumerable, - * false - otherwise. + * false - otherwise */ inline bool __attr_always_inline___ ecma_is_property_enumerable (ecma_property_t property) /**< property */ @@ -1187,7 +1187,7 @@ ecma_set_property_enumerable_attr (ecma_property_t *property_p, /**< [in,out] pr * Get property's 'Configurable' attribute value * * @return true - property is configurable, - * false - otherwise. + * false - otherwise */ inline bool __attr_always_inline___ ecma_is_property_configurable (ecma_property_t property) /**< property */ diff --git a/jerry-core/ecma/base/ecma-literal-storage.c b/jerry-core/ecma/base/ecma-literal-storage.c index b3aff18ac0..54d423487c 100644 --- a/jerry-core/ecma/base/ecma-literal-storage.c +++ b/jerry-core/ecma/base/ecma-literal-storage.c @@ -222,8 +222,8 @@ ecma_find_or_create_literal_number (ecma_number_t number_arg) /**< number to be /** * Save literals to specified snapshot buffer. * - * @return true, if save was performed successfully (i.e. buffer size is sufficient), - * false - otherwise. + * @return true - if save was performed successfully (i.e. buffer size is sufficient), + * false - otherwise */ bool ecma_save_literals_for_snapshot (uint32_t *buffer_p, /**< [out] output snapshot buffer */ @@ -389,8 +389,8 @@ ecma_save_literals_for_snapshot (uint32_t *buffer_p, /**< [out] output snapshot * * Note: always inline because it is used only once. * - * @return true, if load was performed successfully - * false - otherwise (i.e. buffer length is incorrect). + * @return true - if load was performed successfully + * false - otherwise (i.e. buffer length is incorrect) */ static inline bool __attr_always_inline___ ecma_load_literals_from_buffer (const uint16_t *buffer_p, /**< buffer with literal table in snapshot */ @@ -465,8 +465,8 @@ ecma_load_literals_from_buffer (const uint16_t *buffer_p, /**< buffer with liter /** * Load literals from snapshot. * - * @return true, if load was performed successfully (i.e. literals saved in the snapshot are consistent), - * false - otherwise (i.e. snapshot is incorrect). + * @return true - if load was performed successfully (i.e. literals saved in the snapshot are consistent), + * false - otherwise (i.e. snapshot is incorrect) */ bool ecma_load_literals_from_snapshot (const uint32_t *buffer_p, /**< buffer with literal table in snapshot */ diff --git a/jerry-core/ecma/builtin-objects/ecma-builtins.c b/jerry-core/ecma/builtin-objects/ecma-builtins.c index 392b1912fb..94e6e9906a 100644 --- a/jerry-core/ecma/builtin-objects/ecma-builtins.c +++ b/jerry-core/ecma/builtin-objects/ecma-builtins.c @@ -119,8 +119,8 @@ ecma_builtin_get (ecma_builtin_id_t builtin_id) /**< id of built-in to check on /** * Checks whether the given function is a built-in routine * - * @return true if the function object is a built-in routine - * false otherwise + * @return true - if the function object is a built-in routine + * false - otherwise */ inline bool __attr_always_inline___ ecma_builtin_function_is_routine (ecma_object_t *func_obj_p) /**< function object */ diff --git a/jerry-core/ecma/operations/ecma-comparison.c b/jerry-core/ecma/operations/ecma-comparison.c index 1b3c26f9c4..df92fc3f81 100644 --- a/jerry-core/ecma/operations/ecma-comparison.c +++ b/jerry-core/ecma/operations/ecma-comparison.c @@ -32,7 +32,7 @@ * See also: ECMA-262 v5, 11.9.3 * * @return true - if values are equal, - * false - otherwise. + * false - otherwise */ ecma_value_t ecma_op_abstract_equality_compare (ecma_value_t x, /**< first operand */ @@ -187,7 +187,7 @@ ecma_op_abstract_equality_compare (ecma_value_t x, /**< first operand */ * See also: ECMA-262 v5, 11.9.6 * * @return true - if values are strict equal, - * false - otherwise. + * false - otherwise */ bool ecma_op_strict_equality_compare (ecma_value_t x, /**< first operand */ diff --git a/jerry-core/ecma/operations/ecma-conversion.c b/jerry-core/ecma/operations/ecma-conversion.c index 7414398be7..f2951adfc4 100644 --- a/jerry-core/ecma/operations/ecma-conversion.c +++ b/jerry-core/ecma/operations/ecma-conversion.c @@ -71,7 +71,7 @@ ecma_op_check_object_coercible (ecma_value_t value) /**< ecma value */ * ECMA-262 v5, 9.12 * * @return true - if the value are same according to ECMA-defined SameValue algorithm, - * false - otherwise. + * false - otherwise */ bool ecma_op_same_value (ecma_value_t x, /**< ecma value */ @@ -188,8 +188,8 @@ ecma_op_to_primitive (ecma_value_t value, /**< ecma value */ * See also: * ECMA-262 v5, 9.2 * - * @return true if the logical value is true - * false otherwise + * @return true - if the logical value is true + * false - otherwise */ bool ecma_op_to_boolean (ecma_value_t value) /**< ecma value */ diff --git a/jerry-core/ecma/operations/ecma-function-object.c b/jerry-core/ecma/operations/ecma-function-object.c index 63bc1218c7..2184068d5d 100644 --- a/jerry-core/ecma/operations/ecma-function-object.c +++ b/jerry-core/ecma/operations/ecma-function-object.c @@ -42,8 +42,8 @@ * * See also: ECMA-262 v5, 9.11 * - * @return true, if value is callable object; - * false - otherwise. + * @return true - if value is callable object; + * false - otherwise */ bool ecma_op_is_callable (ecma_value_t value) /**< ecma value */ @@ -66,8 +66,8 @@ ecma_op_is_callable (ecma_value_t value) /**< ecma value */ /** * Check whether the value is Object that implements [[Construct]]. * - * @return true, if value is constructor object; - * false - otherwise. + * @return true - if value is constructor object; + * false - otherwise */ bool ecma_is_constructor (ecma_value_t value) /**< ecma value */ diff --git a/jerry-core/ecma/operations/ecma-objects.c b/jerry-core/ecma/operations/ecma-objects.c index 3cc7a2cba4..215bb6bc12 100644 --- a/jerry-core/ecma/operations/ecma-objects.c +++ b/jerry-core/ecma/operations/ecma-objects.c @@ -335,8 +335,8 @@ ecma_op_object_get_property (ecma_object_t *object_p, /**< the object */ /** * Checks whether an object (excluding prototypes) has a named property * - * @return true if property is found - * false otherwise + * @return true - if property is found + * false - otherwise */ inline bool __attr_always_inline___ ecma_op_object_has_own_property (ecma_object_t *object_p, /**< the object */ @@ -353,8 +353,8 @@ ecma_op_object_has_own_property (ecma_object_t *object_p, /**< the object */ /** * Checks whether an object (including prototypes) has a named property * - * @return true if property is found - * false otherwise + * @return true - if property is found + * false - otherwise */ inline bool __attr_always_inline___ ecma_op_object_has_property (ecma_object_t *object_p, /**< the object */ @@ -949,8 +949,8 @@ ecma_op_object_put (ecma_object_t *object_p, /**< the object */ * Note: * returned value must be freed with ecma_free_value * - * @return true, if deleted successfully - * false or type error otherwise (based in 'is_throw') + * @return true - if deleted successfully + * false - or type error otherwise (based in 'is_throw') */ ecma_value_t ecma_op_object_delete (ecma_object_t *obj_p, /**< the object */ @@ -1157,8 +1157,8 @@ ecma_op_object_define_own_property (ecma_object_t *obj_p, /**< the object */ * [Enumerable], [Configurable] * }. * - * @return true if property found - * false otherwise + * @return true - if property found + * false - otherwise */ bool ecma_op_object_get_own_property_descriptor (ecma_object_t *object_p, /**< the object */ @@ -1270,8 +1270,8 @@ ecma_op_object_has_instance (ecma_object_t *obj_p, /**< the object */ * See also: * ECMA-262 v5, 15.2.4.6; 3 * - * @return true if the target object is prototype of the base object - * false if the target object is not prototype of the base object + * @return true - if the target object is prototype of the base object + * false - if the target object is not prototype of the base object */ bool ecma_op_object_is_prototype_of (ecma_object_t *base_p, /**< base object */ diff --git a/jerry-core/jerry-snapshot.c b/jerry-core/jerry-snapshot.c index c8dd029588..9a6dccdc21 100644 --- a/jerry-core/jerry-snapshot.c +++ b/jerry-core/jerry-snapshot.c @@ -45,8 +45,8 @@ typedef struct * Note: * Offset is in-out and is incremented if the write operation completes successfully. * - * @return true, if write was successful, i.e. offset + data_size doesn't exceed buffer size, - * false - otherwise. + * @return true - if write was successful, i.e. offset + data_size doesn't exceed buffer size, + * false - otherwise */ static inline bool __attr_always_inline___ snapshot_write_to_buffer_by_offset (uint8_t *buffer_p, /**< buffer */ @@ -650,7 +650,7 @@ jerry_exec_snapshot (const uint32_t *snapshot_p, /**< snapshot */ * Compare two ecma_strings by size, then lexicographically. * * @return true - if the first string is less than the second one, - * false - otherwise. + * false - otherwise */ static bool jerry_save_literals_compare (ecma_string_t *literal1, /**< first literal */ @@ -838,8 +838,8 @@ jerry_append_number_to_buffer (uint8_t *buffer_p, /**< buffer */ /** * Check whether the passed ecma-string is a valid identifier. * - * @return true, if the ecma-string is a valid identifier, - * false - otherwise. + * @return true - if the ecma-string is a valid identifier, + * false - otherwise */ static bool ecma_string_is_valid_identifier (const ecma_string_t *string_p) diff --git a/jerry-core/jerry.c b/jerry-core/jerry.c index 628fd541bf..910888784f 100644 --- a/jerry-core/jerry.c +++ b/jerry-core/jerry.c @@ -428,7 +428,7 @@ jerry_get_global_object (void) * Check if the specified value is an array object value. * * @return true - if the specified value is an array object, - * false - otherwise. + * false - otherwise */ bool jerry_value_is_array (const jerry_value_t value) /**< jerry api value */ @@ -443,7 +443,7 @@ jerry_value_is_array (const jerry_value_t value) /**< jerry api value */ * Check if the specified value is boolean. * * @return true - if the specified value is boolean, - * false - otherwise. + * false - otherwise */ bool jerry_value_is_boolean (const jerry_value_t value) /**< api value */ @@ -457,7 +457,7 @@ jerry_value_is_boolean (const jerry_value_t value) /**< api value */ * Check if the specified value is a constructor function object value. * * @return true - if the specified value is a function value that implements [[Construct]], - * false - otherwise. + * false - otherwise */ bool jerry_value_is_constructor (const jerry_value_t value) /**< jerry api value */ @@ -471,7 +471,7 @@ jerry_value_is_constructor (const jerry_value_t value) /**< jerry api value */ * Check if the specified value is a function object value. * * @return true - if the specified value is callable, - * false - otherwise. + * false - otherwise */ bool jerry_value_is_function (const jerry_value_t value) /**< api value */ @@ -485,7 +485,7 @@ jerry_value_is_function (const jerry_value_t value) /**< api value */ * Check if the specified value is number. * * @return true - if the specified value is number, - * false - otherwise. + * false - otherwise */ bool jerry_value_is_number (const jerry_value_t value) /**< api value */ @@ -499,7 +499,7 @@ jerry_value_is_number (const jerry_value_t value) /**< api value */ * Check if the specified value is null. * * @return true - if the specified value is null, - * false - otherwise. + * false - otherwise */ bool jerry_value_is_null (const jerry_value_t value) /**< api value */ @@ -513,7 +513,7 @@ jerry_value_is_null (const jerry_value_t value) /**< api value */ * Check if the specified value is object. * * @return true - if the specified value is object, - * false - otherwise. + * false - otherwise */ bool jerry_value_is_object (const jerry_value_t value) /**< api value */ @@ -527,7 +527,7 @@ jerry_value_is_object (const jerry_value_t value) /**< api value */ * Check if the specified value is string. * * @return true - if the specified value is string, - * false - otherwise. + * false - otherwise */ bool jerry_value_is_string (const jerry_value_t value) /**< api value */ @@ -541,7 +541,7 @@ jerry_value_is_string (const jerry_value_t value) /**< api value */ * Check if the specified value is undefined. * * @return true - if the specified value is undefined, - * false - otherwise. + * false - otherwise */ bool jerry_value_is_undefined (const jerry_value_t value) /**< api value */ @@ -555,7 +555,7 @@ jerry_value_is_undefined (const jerry_value_t value) /**< api value */ * Check if the specified feature is enabled. * * @return true - if the specified feature is enabled, - * false - otherwise. + * false - otherwise */ bool jerry_is_feature_enabled (const jerry_feature_t feature) { @@ -593,7 +593,7 @@ bool jerry_is_feature_enabled (const jerry_feature_t feature) * Check if the specified value is an error value. * * @return true - if the error flag of the specified value is true, - * false - otherwise. + * false - otherwise */ bool jerry_value_has_error_flag (const jerry_value_t value) /**< api value */ @@ -1905,7 +1905,7 @@ jerry_set_prototype (const jerry_value_t obj_val, /**< object value */ * Get native handle, associated with specified object * * @return true - if there is an associated handle (handle is returned through out_handle_p), - * false - otherwise. + * false - otherwise */ bool jerry_get_object_native_handle (const jerry_value_t obj_val, /**< object to get handle from */ @@ -1960,7 +1960,7 @@ jerry_set_object_native_handle (const jerry_value_t obj_val, /**< object to set /** * Applies the given function to the every property in the object. * - * @return true, if object fields traversal was performed successfully, i.e.: + * @return true - if object fields traversal was performed successfully, i.e.: * - no unhandled exceptions were thrown in object fields traversal; * - object fields traversal was stopped on callback that returned false; * false - otherwise, diff --git a/jerry-core/lit/lit-char-helpers.c b/jerry-core/lit/lit-char-helpers.c index 8c42f4aa88..05ffe29b0b 100644 --- a/jerry-core/lit/lit-char-helpers.c +++ b/jerry-core/lit/lit-char-helpers.c @@ -105,7 +105,7 @@ search_char_in_interval_array (ecma_char_t c, /**< code unit */ * Check if specified character is one of the Format-Control characters * * @return true - if the character is one of characters, listed in ECMA-262 v5, Table 1, - * false - otherwise. + * false - otherwise */ bool lit_char_is_format_control (ecma_char_t c) /**< code unit */ @@ -120,7 +120,7 @@ lit_char_is_format_control (ecma_char_t c) /**< code unit */ * that fall into "Space, Separator" ("Zs") Unicode character category. * * @return true - if the character is one of characters, listed in ECMA-262 v5, Table 2, - * false - otherwise. + * false - otherwise */ bool lit_char_is_white_space (ecma_char_t c) /**< code unit */ @@ -148,7 +148,7 @@ lit_char_is_white_space (ecma_char_t c) /**< code unit */ * Check if specified character is one of LineTerminator characters * * @return true - if the character is one of characters, listed in ECMA-262 v5, Table 3, - * false - otherwise. + * false - otherwise */ bool lit_char_is_line_terminator (ecma_char_t c) /**< code unit */ @@ -175,7 +175,7 @@ lit_char_is_line_terminator (ecma_char_t c) /**< code unit */ * ECMA-262 v5, 7.6 * * @return true - if specified character falls into one of the listed categories, - * false - otherwise. + * false - otherwise */ static bool lit_char_is_unicode_letter (ecma_char_t c) /**< code unit */ @@ -199,7 +199,7 @@ lit_char_is_unicode_letter (ecma_char_t c) /**< code unit */ * ECMA-262 v5, 7.6 * * @return true - if specified character falls into one of the listed categories, - * false - otherwise. + * false - otherwise */ static bool lit_char_is_unicode_non_letter_ident_part (ecma_char_t c) /**< code unit */ @@ -457,7 +457,7 @@ lit_read_code_unit_from_hex (const lit_utf8_byte_t *buf_p, /**< buffer with char * See also: ECMA-262 v5, 15.10.2.6 (IsWordChar) * * @return true - if the character is a word character - * false - otherwise. + * false - otherwise */ bool lit_char_is_word_char (ecma_char_t c) /**< code unit */ diff --git a/jerry-core/lit/lit-strings.c b/jerry-core/lit/lit-strings.c index b633df13ce..739f5d2923 100644 --- a/jerry-core/lit/lit-strings.c +++ b/jerry-core/lit/lit-strings.c @@ -863,7 +863,7 @@ lit_convert_surrogate_pair_to_code_point (ecma_char_t high_surrogate, /**< high * - first string is prefix of second or is lexicographically less than second. * * @return true - if first string is less than second string, - * false - otherwise. + * false - otherwise */ bool lit_compare_utf8_strings_relational (const lit_utf8_byte_t *string1_p, /**< utf-8 string */ lit_utf8_size_t string1_size, /**< string size */ diff --git a/jerry-core/parser/regexp/re-parser.c b/jerry-core/parser/regexp/re-parser.c index c57af7896d..37671a36b9 100644 --- a/jerry-core/parser/regexp/re-parser.c +++ b/jerry-core/parser/regexp/re-parser.c @@ -36,8 +36,8 @@ /** * Lookup a character in the input string. * - * @return true, if lookup number of characters ahead are hex digits - * false, otherwise + * @return true - if lookup number of characters ahead are hex digits + * false - otherwise */ static bool re_hex_lookup (re_parser_ctx_t *parser_ctx_p, /**< RegExp parser context */ @@ -64,8 +64,8 @@ re_hex_lookup (re_parser_ctx_t *parser_ctx_p, /**< RegExp parser context */ /** * Consume non greedy (question mark) character if present. * - * @return true, if non-greedy character found - * false, otherwise + * @return true - if non-greedy character found + * false - otherwise */ static inline bool __attr_always_inline___ re_parse_non_greedy_char (re_parser_ctx_t *parser_ctx_p) /**< RegExp parser context */ diff --git a/jerry-core/vm/vm-stack.c b/jerry-core/vm/vm-stack.c index 1f25be0848..004001ff84 100644 --- a/jerry-core/vm/vm-stack.c +++ b/jerry-core/vm/vm-stack.c @@ -132,8 +132,8 @@ vm_decode_branch_offset (uint8_t *branch_offset_p, /**< start offset of byte cod /** * Find a finally up to the end position. * - * @return true if 'finally' found, - * false otherwise + * @return true - if 'finally' found, + * false - otherwise */ bool vm_stack_find_finally (vm_frame_ctx_t *frame_ctx_p, /**< frame context */ diff --git a/jerry-core/vm/vm.c b/jerry-core/vm/vm.c index 5eb0e699dd..401369445e 100644 --- a/jerry-core/vm/vm.c +++ b/jerry-core/vm/vm.c @@ -332,8 +332,8 @@ vm_construct_literal_object (vm_frame_ctx_t *frame_ctx_p, /**< frame context */ /** * Get implicit this value * - * @return true, if the implicit 'this' value is updated, - * false - otherwise. + * @return true - if the implicit 'this' value is updated, + * false - otherwise */ static inline bool __attr_always_inline___ vm_get_implicit_this_value (ecma_value_t *this_value_p) /**< [in,out] this value */ @@ -2757,7 +2757,7 @@ vm_run (const ecma_compiled_code_t *bytecode_header_p, /**< byte-code data heade * Check whether currently executed code is strict mode code * * @return true - current code is executed in strict mode, - * false - otherwise. + * false - otherwise */ bool vm_is_strict_mode (void) @@ -2777,7 +2777,7 @@ vm_is_strict_mode (void) * * @return true - currently performed call is performed through 'eval' identifier, * without 'this' argument, - * false - otherwise. + * false - otherwise */ inline bool __attr_always_inline___ vm_is_direct_eval_form_call (void) diff --git a/jerry-main/main-unix.c b/jerry-main/main-unix.c index 0059914b65..936bcc8d6d 100644 --- a/jerry-main/main-unix.c +++ b/jerry-main/main-unix.c @@ -145,7 +145,7 @@ print_help (char *name) /** * Check whether an error is a SyntaxError or not * - * @return true - if param is SyntaxError + * @return true - if param is SyntaxError * false - otherwise */ static bool diff --git a/targets/default/jerry-port-default-fatal.c b/targets/default/jerry-port-default-fatal.c index 865a329808..ae25e785e5 100644 --- a/targets/default/jerry-port-default-fatal.c +++ b/targets/default/jerry-port-default-fatal.c @@ -34,7 +34,7 @@ void jerry_port_default_set_abort_on_fail (bool flag) /**< new value of 'abort o * non-zero exit code in the default implementation of jerry_port_fatal. * * @return true - if 'abort on fail' flag is set, - * false - otherwise. + * false - otherwise */ bool jerry_port_default_is_abort_on_fail (void) {