diff --git a/jerry-core/ecma/base/ecma-helpers-conversion.c b/jerry-core/ecma/base/ecma-helpers-conversion.c index 581f50dd0b..ae26385000 100644 --- a/jerry-core/ecma/base/ecma-helpers-conversion.c +++ b/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)); diff --git a/jerry-core/ecma/base/ecma-helpers-external-pointers.c b/jerry-core/ecma/base/ecma-helpers-external-pointers.c index 44cf30341a..b0607d62ad 100644 --- a/jerry-core/ecma/base/ecma-helpers-external-pointers.c +++ b/jerry-core/ecma/base/ecma-helpers-external-pointers.c @@ -106,7 +106,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 diff --git a/jerry-core/ecma/base/ecma-helpers-number.c b/jerry-core/ecma/base/ecma-helpers-number.c index e76cc2180e..5ba16a7864 100644 --- a/jerry-core/ecma/base/ecma-helpers-number.c +++ b/jerry-core/ecma/base/ecma-helpers-number.c @@ -65,9 +65,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; @@ -152,9 +152,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; @@ -364,8 +364,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)); diff --git a/jerry-core/ecma/base/ecma-helpers-string.c b/jerry-core/ecma/base/ecma-helpers-string.c index 2b42c97b6b..fe420909c1 100644 --- a/jerry-core/ecma/base/ecma-helpers-string.c +++ b/jerry-core/ecma/base/ecma-helpers-string.c @@ -609,7 +609,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) @@ -1302,7 +1302,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]; @@ -1323,7 +1323,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]; @@ -1342,7 +1342,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) { @@ -1375,7 +1375,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) { diff --git a/jerry-core/ecma/base/ecma-lcache.c b/jerry-core/ecma/base/ecma-lcache.c index 580c9fbe31..55dd42f935 100644 --- a/jerry-core/ecma/base/ecma-lcache.c +++ b/jerry-core/ecma/base/ecma-lcache.c @@ -236,11 +236,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 diff --git a/jerry-core/ecma/builtin-objects/ecma-builtin-helpers-date.c b/jerry-core/ecma/builtin-objects/ecma-builtin-helpers-date.c index c29578ba81..dc1d85aa5c 100644 --- a/jerry-core/ecma/builtin-objects/ecma-builtin-helpers-date.c +++ b/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 */ { diff --git a/jerry-core/ecma/builtin-objects/ecma-builtin-helpers.c b/jerry-core/ecma/builtin-objects/ecma-builtin-helpers.c index 139576fadc..6900e7f0aa 100644 --- a/jerry-core/ecma/builtin-objects/ecma-builtin-helpers.c +++ b/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); diff --git a/jerry-core/ecma/operations/ecma-conversion.c b/jerry-core/ecma/operations/ecma-conversion.c index 4145be83e8..a5563d8ae2 100644 --- a/jerry-core/ecma/operations/ecma-conversion.c +++ b/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 */ { diff --git a/jerry-core/ecma/operations/ecma-regexp-object.c b/jerry-core/ecma/operations/ecma-regexp-object.c index 220cc6437e..4f9ab65327 100644 --- a/jerry-core/ecma/operations/ecma-regexp-object.c +++ b/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; diff --git a/jerry-core/jerry.c b/jerry-core/jerry.c index b1058067df..6af0685fed 100644 --- a/jerry-core/jerry.c +++ b/jerry-core/jerry.c @@ -372,7 +372,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 */ @@ -435,7 +435,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) @@ -521,7 +521,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 */ { @@ -559,7 +559,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] output characters buffer */ ssize_t buffer_size) /**< size of output buffer */ { jerry_assert_api_available (); @@ -1117,7 +1117,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, @@ -1197,7 +1197,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 (); @@ -1293,7 +1293,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 (); @@ -1454,7 +1454,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); @@ -1578,7 +1578,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 (); @@ -1665,9 +1665,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; @@ -2286,7 +2286,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)); diff --git a/jerry-core/jrt/jrt.c b/jerry-core/jrt/jrt.c index 3813f3c6fd..d9690f4284 100644 --- a/jerry-core/jrt/jrt.c +++ b/jerry-core/jrt/jrt.c @@ -28,9 +28,9 @@ bool __attr_always_inline___ jrt_read_from_buffer_by_offset (const uint8_t *buffer_p, /**< buffer */ size_t buffer_size, /**< size of buffer */ - size_t *in_out_buffer_offset_p, /**< in: offset to read from, - * out: offset, incremented on sizeof (T) */ - void *out_data_p, /**< out: data */ + size_t *in_out_buffer_offset_p, /**< [in,out] offset to read from / + * incremented on sizeof (T) */ + void *out_data_p, /**< [out] data */ size_t out_data_size) /**< size of the readable data */ { if (*in_out_buffer_offset_p + out_data_size > buffer_size) @@ -56,8 +56,8 @@ jrt_read_from_buffer_by_offset (const uint8_t *buffer_p, /**< buffer */ bool __attr_always_inline___ jrt_write_to_buffer_by_offset (uint8_t *buffer_p, /**< buffer */ size_t buffer_size, /**< size of buffer */ - size_t *in_out_buffer_offset_p, /**< in: offset to read from, - * out: offset, incremented on sizeof (T) */ + size_t *in_out_buffer_offset_p, /**< [in,out] offset to read from / + * incremented on sizeof (T) */ const void *data_p, /**< data */ size_t data_size) /**< size of the writable data */ { diff --git a/jerry-core/lit/lit-char-helpers.c b/jerry-core/lit/lit-char-helpers.c index 4c5d3381b1..9da945ec53 100644 --- a/jerry-core/lit/lit-char-helpers.c +++ b/jerry-core/lit/lit-char-helpers.c @@ -392,7 +392,7 @@ lit_char_is_word_char (ecma_char_t c) /**< code unit */ */ lit_utf8_size_t lit_char_to_lower_case (ecma_char_t character, /**< input character value */ - ecma_char_t *output_buffer_p, /**< buffer for the result characters */ + ecma_char_t *output_buffer_p, /**< [out] buffer for the result characters */ size_t buffer_size) /**< buffer size */ { TODO ("Needs a proper lower case implementation. See issue #323."); diff --git a/jerry-core/lit/lit-magic-strings.c b/jerry-core/lit/lit-magic-strings.c index 3d554ef271..82e0abc4ae 100644 --- a/jerry-core/lit/lit-magic-strings.c +++ b/jerry-core/lit/lit-magic-strings.c @@ -160,7 +160,7 @@ lit_magic_strings_ex_set (const lit_utf8_byte_t **ex_str_items, /**< character a bool lit_is_utf8_string_magic (const lit_utf8_byte_t *string_p, /**< utf-8 string */ lit_utf8_size_t string_size, /**< string size in bytes */ - 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 */ { TODO (Improve performance of search); @@ -190,7 +190,7 @@ lit_is_utf8_string_magic (const lit_utf8_byte_t *string_p, /**< utf-8 string */ */ bool lit_is_ex_utf8_string_magic (const lit_utf8_byte_t *string_p, /**< utf-8 string */ lit_utf8_size_t string_size, /**< string size in bytes */ - lit_magic_string_ex_id_t *out_id_p) /**< out: magic string's id */ + lit_magic_string_ex_id_t *out_id_p) /**< [out] magic string's id */ { TODO (Improve performance of search); diff --git a/jerry-core/lit/lit-snapshot.c b/jerry-core/lit/lit-snapshot.c index 7772aa5582..900cc33c48 100644 --- a/jerry-core/lit/lit-snapshot.c +++ b/jerry-core/lit/lit-snapshot.c @@ -31,7 +31,7 @@ static uint32_t lit_snapshot_dump (lit_literal_t lit, /**< literal to dump */ uint8_t *buffer_p, /**< buffer to dump to */ size_t buffer_size, /**< buffer size */ - size_t *in_out_buffer_offset_p) /**< in-out: buffer write offset */ + size_t *in_out_buffer_offset_p) /**< [in,out] buffer write offset */ { const lit_record_type_t record_type = (lit_record_type_t) lit->type; switch (record_type) @@ -127,14 +127,14 @@ lit_snapshot_dump (lit_literal_t lit, /**< literal to dump */ * false - otherwise. */ bool -lit_dump_literals_for_snapshot (uint8_t *buffer_p, /**< output snapshot buffer */ +lit_dump_literals_for_snapshot (uint8_t *buffer_p, /**< [out] output snapshot buffer */ size_t buffer_size, /**< size of the buffer */ - size_t *in_out_buffer_offset_p, /**< in-out: write position in the buffer */ - lit_mem_to_snapshot_id_map_entry_t **out_map_p, /**< out: map from literal identifiers + size_t *in_out_buffer_offset_p, /**< [in,out] write position in the buffer */ + lit_mem_to_snapshot_id_map_entry_t **out_map_p, /**< [out] map from literal identifiers * to the literal offsets * in snapshot */ - uint32_t *out_map_num_p, /**< out: number of literals */ - uint32_t *out_lit_table_size_p) /**< out: number of bytes, dumped to snapshot buffer */ + uint32_t *out_map_num_p, /**< [out] number of literals */ + uint32_t *out_lit_table_size_p) /**< [out] number of bytes, dumped to snapshot buffer */ { uint32_t literals_num = lit_count_literals (); uint32_t lit_table_size = 0; @@ -256,11 +256,11 @@ lit_dump_literals_for_snapshot (uint8_t *buffer_p, /**< output snapshot buffer * bool lit_load_literals_from_snapshot (const uint8_t *lit_table_p, /**< buffer with literal table in snapshot */ uint32_t lit_table_size, /**< size of literal table in snapshot */ - lit_mem_to_snapshot_id_map_entry_t **out_map_p, /**< out: map from literal offsets + lit_mem_to_snapshot_id_map_entry_t **out_map_p, /**< [out] map from literal offsets * in snapshot to identifiers * of loaded literals in literal * storage */ - uint32_t *out_map_num_p) /**< out: literals number */ + uint32_t *out_map_num_p) /**< [out] literals number */ { *out_map_p = NULL; *out_map_num_p = 0; diff --git a/jerry-core/lit/lit-strings.c b/jerry-core/lit/lit-strings.c index 5fc8f3d013..a3dd08bd01 100644 --- a/jerry-core/lit/lit-strings.c +++ b/jerry-core/lit/lit-strings.c @@ -603,7 +603,7 @@ lit_read_prev_code_unit_from_utf8 (const lit_utf8_byte_t *buf_p, /**< buffer wit * @return next code unit */ ecma_char_t -lit_utf8_read_next (lit_utf8_byte_t **buf_p) /**< in-out:buffer with characters */ +lit_utf8_read_next (lit_utf8_byte_t **buf_p) /**< [in,out] buffer with characters */ { JERRY_ASSERT (*buf_p); ecma_char_t ch; @@ -619,7 +619,7 @@ lit_utf8_read_next (lit_utf8_byte_t **buf_p) /**< in-out:buffer with characters * @return previous code unit */ ecma_char_t -lit_utf8_read_prev (lit_utf8_byte_t **buf_p) /**< in-out:buffer with characters */ +lit_utf8_read_prev (lit_utf8_byte_t **buf_p) /**< [in,out] buffer with characters */ { JERRY_ASSERT (*buf_p); ecma_char_t ch; @@ -636,7 +636,7 @@ lit_utf8_read_prev (lit_utf8_byte_t **buf_p) /**< in-out:buffer with characters * @return next code unit */ ecma_char_t -lit_utf8_peek_next (const lit_utf8_byte_t *buf_p) /**< in-out:buffer with characters */ +lit_utf8_peek_next (const lit_utf8_byte_t *buf_p) /**< [in,out] buffer with characters */ { JERRY_ASSERT (buf_p); ecma_char_t ch; @@ -652,7 +652,7 @@ lit_utf8_peek_next (const lit_utf8_byte_t *buf_p) /**< in-out:buffer with charac * @return previous code unit */ ecma_char_t -lit_utf8_peek_prev (const lit_utf8_byte_t *buf_p) /**< in-out:buffer with characters */ +lit_utf8_peek_prev (const lit_utf8_byte_t *buf_p) /**< [in,out] buffer with characters */ { JERRY_ASSERT (buf_p); ecma_char_t ch; @@ -666,7 +666,7 @@ lit_utf8_peek_prev (const lit_utf8_byte_t *buf_p) /**< in-out:buffer with charac * Increase cesu-8 encoded string pointer by one code unit. */ void -lit_utf8_incr (lit_utf8_byte_t **buf_p) /**< in-out:buffer with characters */ +lit_utf8_incr (lit_utf8_byte_t **buf_p) /**< [in,out] buffer with characters */ { JERRY_ASSERT (*buf_p); @@ -677,7 +677,7 @@ lit_utf8_incr (lit_utf8_byte_t **buf_p) /**< in-out:buffer with characters */ * Decrease cesu-8 encoded string pointer by one code unit. */ void -lit_utf8_decr (lit_utf8_byte_t **buf_p) /**< in-out:buffer with characters */ +lit_utf8_decr (lit_utf8_byte_t **buf_p) /**< [in,out] buffer with characters */ { JERRY_ASSERT (*buf_p); lit_utf8_byte_t *current_p = *buf_p; diff --git a/jerry-core/mem/mem-heap.c b/jerry-core/mem/mem-heap.c index 6e95b84911..daf828ae03 100644 --- a/jerry-core/mem/mem-heap.c +++ b/jerry-core/mem/mem-heap.c @@ -660,7 +660,7 @@ mem_heap_print () * Get heap memory usage statistics */ void -mem_heap_get_stats (mem_heap_stats_t *out_heap_stats_p) /**< out: heap stats */ +mem_heap_get_stats (mem_heap_stats_t *out_heap_stats_p) /**< [out] heap stats */ { *out_heap_stats_p = mem_heap_stats; } /* mem_heap_get_stats */ diff --git a/jerry-core/mem/mem-poolman.c b/jerry-core/mem/mem-poolman.c index e854c9bee5..fde5c5d361 100644 --- a/jerry-core/mem/mem-poolman.c +++ b/jerry-core/mem/mem-poolman.c @@ -201,7 +201,7 @@ mem_pools_collect_empty () * Get pools memory usage statistics */ void -mem_pools_get_stats (mem_pools_stats_t *out_pools_stats_p) /**< out: pools' stats */ +mem_pools_get_stats (mem_pools_stats_t *out_pools_stats_p) /**< [out] pools' stats */ { JERRY_ASSERT (out_pools_stats_p != NULL); diff --git a/jerry-core/parser/regexp/re-compiler.c b/jerry-core/parser/regexp/re-compiler.c index e3ec8fcc8c..d53d6fcb72 100644 --- a/jerry-core/parser/regexp/re-compiler.c +++ b/jerry-core/parser/regexp/re-compiler.c @@ -631,7 +631,7 @@ re_parse_alternative (re_compiler_ctx_t *re_ctx_p, /**< RegExp compiler context * Returned value must be freed with ecma_free_value */ ecma_value_t -re_compile_bytecode (re_compiled_code_t **out_bytecode_p, /**< out:pointer to bytecode */ +re_compile_bytecode (re_compiled_code_t **out_bytecode_p, /**< [out]pointer to bytecode */ ecma_string_t *pattern_str_p, /**< pattern */ uint16_t flags) /**< flags */ { diff --git a/jerry-core/parser/regexp/re-parser.c b/jerry-core/parser/regexp/re-parser.c index e84447f2f3..78ea9fd591 100644 --- a/jerry-core/parser/regexp/re-parser.c +++ b/jerry-core/parser/regexp/re-parser.c @@ -110,7 +110,7 @@ re_parse_octal (re_parser_ctx_t *parser_ctx_p) /**< RegExp parser context */ */ static ecma_value_t re_parse_iterator (re_parser_ctx_t *parser_ctx_p, /**< RegExp parser context */ - re_token_t *re_token_p) /**< out: output token */ + re_token_t *re_token_p) /**< [out] output token */ { ecma_value_t ret_value = ecma_make_simple_value (ECMA_SIMPLE_VALUE_EMPTY); @@ -307,7 +307,7 @@ re_parse_char_class (re_parser_ctx_t *parser_ctx_p, /**< number of classes */ * which adds the char-ranges * to the bytecode */ void *re_ctx_p, /**< regexp compiler context */ - re_token_t *out_token_p) /**< out: output token */ + re_token_t *out_token_p) /**< [out] output token */ { re_token_type_t token_type = ((re_compiler_ctx_t *) re_ctx_p)->current_token.type; out_token_p->qmax = out_token_p->qmin = 1; @@ -561,7 +561,7 @@ re_parse_char_class (re_parser_ctx_t *parser_ctx_p, /**< number of classes */ */ ecma_value_t re_parse_next_token (re_parser_ctx_t *parser_ctx_p, /**< RegExp parser context */ - re_token_t *out_token_p) /**< out: output token */ + re_token_t *out_token_p) /**< [out] output token */ { ecma_value_t ret_value = ecma_make_simple_value (ECMA_SIMPLE_VALUE_EMPTY); diff --git a/jerry-core/vm/vm.c b/jerry-core/vm/vm.c index 5ba78ff271..c65c4b208c 100644 --- a/jerry-core/vm/vm.c +++ b/jerry-core/vm/vm.c @@ -308,7 +308,7 @@ vm_construct_literal_object (vm_frame_ctx_t *frame_ctx_p, /**< frame context */ * false - otherwise. */ static bool __attr_always_inline___ -vm_get_implicit_this_value (ecma_value_t *this_value_p) /**< in-out: this value */ +vm_get_implicit_this_value (ecma_value_t *this_value_p) /**< [in,out] this value */ { if (ecma_is_value_object (*this_value_p)) {