Style fix: return value comments (#1668)

JerryScript-DCO-1.0-Signed-off-by: Levente Orban orbanl@inf.u-szeged.hu

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 */

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 */

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 */

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 */

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 */

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 */

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 */

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 */

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 */

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 */

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 */