Fix the format of doxygen comments of output arguments

JerryScript-DCO-1.0-Signed-off-by: László Langó llango.u-szeged@partner.samsung.com

Author: LaszloLango

jerry-core/ecma/base/ecma-helpers-conversion.c

@@ -972,7 +972,7 @@ ecma_number_to_int32 (ecma_number_t num) /**< ecma-number */
 static void
 ecma_number_helper_binary_to_decimal (ECMA_NUMBER_CONVERSION_128BIT_INTEGER_ARG (fraction_uint128), /**< mantissa */
                                       int32_t binary_exponent, /**< binary exponent */
-                                      int32_t *out_decimal_exp_p) /**< out: decimal exponent */
+                                      int32_t *out_decimal_exp_p) /**< [out] decimal exponent */
 {
   int32_t decimal_exp = 0;
 
@@ -1043,9 +1043,9 @@ ecma_number_helper_binary_to_decimal (ECMA_NUMBER_CONVERSION_128BIT_INTEGER_ARG
   */
 void
 ecma_number_to_decimal (ecma_number_t num, /**< ecma-number */
-                        uint64_t *out_digits_p, /**< out: digits */
-                        int32_t *out_digits_num_p, /**< out: number of digits */
-                        int32_t *out_decimal_exp_p) /**< out: decimal exponent */
+                        uint64_t *out_digits_p, /**< [out] digits */
+                        int32_t *out_digits_num_p, /**< [out] number of digits */
+                        int32_t *out_decimal_exp_p) /**< [out] decimal exponent */
 {
   JERRY_ASSERT (!ecma_number_is_nan (num));
   JERRY_ASSERT (!ecma_number_is_zero (num));

jerry-core/ecma/base/ecma-helpers-external-pointers.c

@@ -104,7 +104,7 @@ bool
 ecma_get_external_pointer_value (ecma_object_t *obj_p, /**< object to get property value from */
                                  ecma_internal_property_id_t id, /**< identifier of internal property
                                                                   *   to get value from */
-                                 ecma_external_pointer_t *out_pointer_p) /**< out: value of the external pointer */
+                                 ecma_external_pointer_t *out_pointer_p) /**< [out] value of the external pointer */
 {
   JERRY_ASSERT (id == ECMA_INTERNAL_PROPERTY_NATIVE_CODE
                 || id == ECMA_INTERNAL_PROPERTY_NATIVE_HANDLE

jerry-core/ecma/base/ecma-helpers-number.c

@@ -64,9 +64,9 @@ ecma_number_pack (bool sign, /**< sign */
  */
 static void
 ecma_number_unpack (ecma_number_t num, /**< ecma-number */
-                    bool *sign_p, /**< optional out: sign */
-                    uint32_t *biased_exp_p, /**< optional out: biased exponent */
-                    uint64_t *fraction_p) /**< optional out: fraction */
+                    bool *sign_p, /**< [out] sign (optional) */
+                    uint32_t *biased_exp_p, /**< [out] biased exponent (optional) */
+                    uint64_t *fraction_p) /**< [out] fraction (optional) */
 {
   const uint32_t fraction_pos = 0;
   const uint32_t biased_exp_pos = fraction_pos + ECMA_NUMBER_FRACTION_WIDTH;
@@ -150,9 +150,9 @@ ecma_number_pack (bool sign, /**< sign */
  */
 static void
 ecma_number_unpack (ecma_number_t num, /**< ecma-number */
-                    bool *sign_p, /**< optional out: sign */
-                    uint32_t *biased_exp_p, /**< optional out: biased exponent */
-                    uint64_t *fraction_p) /**< optional out: fraction */
+                    bool *sign_p, /**< [out] sign (optional) */
+                    uint32_t *biased_exp_p, /**< [out] biased exponent (optional) */
+                    uint64_t *fraction_p) /**< [out] fraction (optional) */
 {
   const uint32_t fraction_pos = 0;
   const uint32_t biased_exp_pos = fraction_pos + ECMA_NUMBER_FRACTION_WIDTH;
@@ -362,8 +362,8 @@ ecma_number_is_infinity (ecma_number_t num) /**< ecma-number */
  */
 int32_t
 ecma_number_get_fraction_and_exponent (ecma_number_t num, /**< ecma-number */
-                                       uint64_t *out_fraction_p, /**< out: fraction of the number */
-                                       int32_t *out_exponent_p) /**< out: exponent of the number */
+                                       uint64_t *out_fraction_p, /**< [out] fraction of the number */
+                                       int32_t *out_exponent_p) /**< [out] exponent of the number */
 {
   JERRY_ASSERT (!ecma_number_is_nan (num));
 

jerry-core/ecma/base/ecma-helpers-string.c

@@ -843,7 +843,7 @@ ecma_string_to_number (const ecma_string_t *str_p) /**< ecma-string */
  */
 bool
 ecma_string_get_array_index (const ecma_string_t *str_p, /**< ecma-string */
-                             uint32_t *out_index_p) /**< out: index */
+                             uint32_t *out_index_p) /**< [out] index */
 {
   bool is_array_index = true;
   if (str_p->container == ECMA_STRING_CONTAINER_UINT32_IN_DESC)
@@ -1452,7 +1452,7 @@ ecma_get_magic_string_ex (lit_magic_string_ex_id_t id) /**< external magic strin
  */
 static bool
 ecma_is_string_magic_longpath (const ecma_string_t *string_p, /**< ecma-string */
-                               lit_magic_string_id_t *out_id_p) /**< out: magic string's id */
+                               lit_magic_string_id_t *out_id_p) /**< [out] magic string's id */
 {
   lit_utf8_byte_t utf8_string_buffer[LIT_MAGIC_STRING_LENGTH_LIMIT];
 
@@ -1473,7 +1473,7 @@ ecma_is_string_magic_longpath (const ecma_string_t *string_p, /**< ecma-string *
  */
 static bool
 ecma_is_ex_string_magic_longpath (const ecma_string_t *string_p, /**< ecma-string */
-                                  lit_magic_string_ex_id_t *out_id_p) /**< out: external magic string's id */
+                                  lit_magic_string_ex_id_t *out_id_p) /**< [out] external magic string's id */
 {
   lit_utf8_byte_t utf8_string_buffer[LIT_MAGIC_STRING_LENGTH_LIMIT];
 
@@ -1492,7 +1492,7 @@ ecma_is_ex_string_magic_longpath (const ecma_string_t *string_p, /**< ecma-strin
  */
 bool
 ecma_is_string_magic (const ecma_string_t *string_p, /**< ecma-string */
-                      lit_magic_string_id_t *out_id_p) /**< out: magic string's id */
+                      lit_magic_string_id_t *out_id_p) /**< [out] magic string's id */
 {
   if (string_p->container == ECMA_STRING_CONTAINER_MAGIC_STRING)
   {
@@ -1525,7 +1525,7 @@ ecma_is_string_magic (const ecma_string_t *string_p, /**< ecma-string */
  */
 bool
 ecma_is_ex_string_magic (const ecma_string_t *string_p, /**< ecma-string */
-                         lit_magic_string_ex_id_t *out_id_p) /**< out: external magic string's id */
+                         lit_magic_string_ex_id_t *out_id_p) /**< [out] external magic string's id */
 {
   if (string_p->container == ECMA_STRING_CONTAINER_MAGIC_STRING_EX)
   {

jerry-core/ecma/base/ecma-lcache.c

@@ -235,11 +235,11 @@ ecma_lcache_insert (ecma_object_t *object_p, /**< object */
 bool __attr_always_inline___
 ecma_lcache_lookup (ecma_object_t *object_p, /**< object */
                     const ecma_string_t *prop_name_p, /**< property's name */
-                    ecma_property_t **prop_p_p) /**< out: if return value is true,
+                    ecma_property_t **prop_p_p) /**< [out] if return value is true,
                                                  *         then here will be pointer to property,
                                                  *         if the object contains property with specified name,
                                                  *         or, otherwise - NULL;
-                                                 *        if return value is false,
+                                                 *         if return value is false,
                                                  *         then the output parameter is not set */
 {
 #ifndef CONFIG_ECMA_LCACHE_DISABLE

jerry-core/ecma/builtin-objects/ecma-builtin-helpers-date.c

@@ -925,7 +925,7 @@ ecma_date_set_internal_property (ecma_value_t this_arg, /**< this argument */
  * Insert leading zeros to a string of a number if needed.
  */
 void
-ecma_date_insert_leading_zeros (ecma_string_t **str_p, /**< input/output string */
+ecma_date_insert_leading_zeros (ecma_string_t **str_p, /**< [in, out] ecma string */
                                 ecma_number_t num, /**< input number */
                                 uint32_t length) /**< length of string of number */
 {

jerry-core/ecma/builtin-objects/ecma-builtin-helpers.c

@@ -328,7 +328,7 @@ ecma_builtin_helper_array_index_normalize (ecma_number_t index, /**< index */
  */
 ecma_value_t
 ecma_builtin_helper_array_concat_value (ecma_object_t *obj_p, /**< array */
-                                        uint32_t *length_p, /**< in-out: array's length */
+                                        uint32_t *length_p, /**< [in, out] array's length */
                                         ecma_value_t value) /**< value to concat */
 {
   ecma_value_t ret_value = ecma_make_simple_value (ECMA_SIMPLE_VALUE_EMPTY);

jerry-core/ecma/operations/ecma-conversion.c

@@ -567,7 +567,7 @@ ecma_op_from_property_descriptor (const ecma_property_descriptor_t *src_prop_des
  */
 ecma_value_t
 ecma_op_to_property_descriptor (ecma_value_t obj_value, /**< object value */
-                                ecma_property_descriptor_t *out_prop_desc_p) /**< out: filled property descriptor
+                                ecma_property_descriptor_t *out_prop_desc_p) /**< [out] filled property descriptor
                                                                                   if return value is normal
                                                                                   empty completion value */
 {

jerry-core/ecma/operations/ecma-regexp-object.c

@@ -65,7 +65,7 @@
  */
 ecma_value_t
 re_parse_regexp_flags (ecma_string_t *flags_str_p, /**< Input string with flags */
-                       uint16_t *flags_p) /**< Output: parsed flag bits */
+                       uint16_t *flags_p) /**< [out] parsed flag bits */
 {
   ecma_value_t ret_value = ecma_make_simple_value (ECMA_SIMPLE_VALUE_EMPTY);
 
@@ -374,7 +374,7 @@ static ecma_value_t
 re_match_regexp (re_matcher_ctx_t *re_ctx_p, /**< RegExp matcher context */
                  uint8_t *bc_p, /**< pointer to the current RegExp bytecode */
                  lit_utf8_byte_t *str_p, /**< input string pointer */
-                 lit_utf8_byte_t **out_str_p) /**< Output: matching substring iterator */
+                 lit_utf8_byte_t **out_str_p) /**< [out] matching substring iterator */
 {
   ecma_value_t ret_value = ecma_make_simple_value (ECMA_SIMPLE_VALUE_EMPTY);
   re_opcode_t op;

jerry-core/jerry.c

@@ -371,7 +371,7 @@ jerry_api_create_string_value (jerry_api_string_t *value) /**< jerry_api_string_
  *      just when it becomes unnecessary.
  */
 static void
-jerry_api_convert_ecma_value_to_api_value (jerry_api_value_t *out_value_p, /**< out: api value */
+jerry_api_convert_ecma_value_to_api_value (jerry_api_value_t *out_value_p, /**< [out] api value */
                                            ecma_value_t value) /**< ecma value (undefined,
                                                                 *   null, boolean, number,
                                                                 *   string or object */
@@ -434,7 +434,7 @@ jerry_api_convert_ecma_value_to_api_value (jerry_api_value_t *out_value_p, /**<
  *      the output ecma value should be freed with ecma_free_value when it becomes unnecessary.
  */
 static void
-jerry_api_convert_api_value_to_ecma_value (ecma_value_t *out_value_p, /**< out: ecma value */
+jerry_api_convert_api_value_to_ecma_value (ecma_value_t *out_value_p, /**< [out] ecma value */
                                            const jerry_api_value_t *api_value_p) /**< value in Jerry API format */
 {
   switch (api_value_p->type)
@@ -520,7 +520,7 @@ jerry_api_convert_api_value_to_ecma_value (ecma_value_t *out_value_p, /**< out:
  * @return completion code
  */
 static jerry_completion_code_t
-jerry_api_convert_eval_completion_to_retval (jerry_api_value_t *retval_p, /**< out: api value */
+jerry_api_convert_eval_completion_to_retval (jerry_api_value_t *retval_p, /**< [out] api value */
                                              ecma_value_t completion) /**< completion of 'eval'-mode
                                                                        *   code execution */
 {
@@ -558,7 +558,7 @@ jerry_api_convert_eval_completion_to_retval (jerry_api_value_t *retval_p, /**< o
  */
 ssize_t
 jerry_api_string_to_char_buffer (const jerry_api_string_t *string_p, /**< string descriptor */
-                                 jerry_api_char_t *buffer_p, /**< output characters buffer */
+                                 jerry_api_char_t *buffer_p, /**< [out] characters buffer */
                                  ssize_t buffer_size) /**< size of output buffer */
 {
   jerry_assert_api_available ();
@@ -1116,7 +1116,7 @@ jerry_api_delete_object_field (jerry_api_object_t *object_p, /**< object to dele
  */
 bool jerry_api_get_object_field_value (jerry_api_object_t *object_p, /**< object */
                                        const jerry_api_char_t *field_name_p, /**< field name */
-                                       jerry_api_value_t *field_value_p) /**< out: field value */
+                                       jerry_api_value_t *field_value_p) /**< [out] field value */
 {
   return jerry_api_get_object_field_value_sz (object_p,
                                               field_name_p,
@@ -1196,7 +1196,7 @@ bool
 jerry_api_get_object_field_value_sz (jerry_api_object_t *object_p, /**< object */
                                      const jerry_api_char_t *field_name_p, /**< name of the field */
                                      jerry_api_size_t field_name_size, /**< size of field name in bytes */
-                                     jerry_api_value_t *field_value_p) /**< out: field value, if retrieved
+                                     jerry_api_value_t *field_value_p) /**< [out] field value, if retrieved
  * successfully */
 {
   jerry_assert_api_available ();
@@ -1292,7 +1292,7 @@ jerry_api_set_object_field_value_sz (jerry_api_object_t *object_p, /**< object *
  */
 bool
 jerry_api_get_object_native_handle (jerry_api_object_t *object_p, /**< object to get handle from */
-                                    uintptr_t *out_handle_p) /**< out: handle value */
+                                    uintptr_t *out_handle_p) /**< [out] handle value */
 {
   jerry_assert_api_available ();
 
@@ -1452,7 +1452,7 @@ jerry_api_invoke_function (bool is_invoke_as_constructor, /**< true - invoke fun
  * Construct new TypeError object
  */
 static void
-jerry_api_construct_type_error (jerry_api_value_t *retval_p) /**< out: value with constructed
+jerry_api_construct_type_error (jerry_api_value_t *retval_p) /**< [out] value with constructed
                                                               *        TypeError object */
 {
   ecma_object_t *type_error_obj_p = ecma_new_standard_error (ECMA_ERROR_TYPE);
@@ -1576,7 +1576,7 @@ jerry_api_eval (const jerry_api_char_t *source_p, /**< source code */
                 size_t source_size, /**< length of source code */
                 bool is_direct, /**< perform eval invocation in direct mode */
                 bool is_strict, /**< perform eval as it is called from strict mode code */
-                jerry_api_value_t *retval_p) /**< out: returned value */
+                jerry_api_value_t *retval_p) /**< [out] returned value */
 {
   jerry_assert_api_available ();
 
@@ -1663,9 +1663,9 @@ jerry_cleanup (void)
  * Get Jerry configured memory limits
  */
 void
-jerry_get_memory_limits (size_t *out_data_bss_brk_limit_p, /**< out: Jerry's maximum usage of
+jerry_get_memory_limits (size_t *out_data_bss_brk_limit_p, /**< [out] Jerry's maximum usage of
                                                             *        data + bss + brk sections */
-                         size_t *out_stack_limit_p) /**< out: Jerry's maximum usage of stack */
+                         size_t *out_stack_limit_p) /**< [out] Jerry's maximum usage of stack */
 {
   *out_data_bss_brk_limit_p = CONFIG_MEM_HEAP_AREA_SIZE + CONFIG_MEM_DATA_LIMIT_MINUS_HEAP_SIZE;
   *out_stack_limit_p = CONFIG_MEM_STACK_LIMIT;
@@ -2295,7 +2295,7 @@ jerry_exec_snapshot (const void *snapshot_p, /**< snapshot */
                                           *   buffer could be freed after the call).
                                           *   Otherwise (if the flag is not set) - the buffer could only be
                                           *   freed after the engine stops (i.e. after call to jerry_cleanup). */
-                     jerry_api_value_t *retval_p) /**< out: returned value (ECMA-262 'undefined' if
+                     jerry_api_value_t *retval_p) /**< [out] returned value (ECMA-262 'undefined' if
                                                    * code is executed as global scope code) */
 {
   jerry_api_convert_ecma_value_to_api_value (retval_p, ecma_make_simple_value (ECMA_SIMPLE_VALUE_UNDEFINED));