Skip to content

Commit 0af43f8

Browse files
LaszloLangoLaszloLango
committed
Fix the format of doxygen comments of output arguments
JerryScript-DCO-1.0-Signed-off-by: László Langó [email protected]
1 parent 76b37f3 commit 0af43f8

22 files changed

+70
-70
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -972,7 +972,7 @@ ecma_number_to_int32 (ecma_number_t num) /**< ecma-number */
972972
static void
973973
ecma_number_helper_binary_to_decimal (ECMA_NUMBER_CONVERSION_128BIT_INTEGER_ARG (fraction_uint128), /**< mantissa */
974974
int32_t binary_exponent, /**< binary exponent */
975-
int32_t *out_decimal_exp_p) /**< out: decimal exponent */
975+
int32_t *out_decimal_exp_p) /**< [out] decimal exponent */
976976
{
977977
int32_t decimal_exp = 0;
978978

@@ -1043,9 +1043,9 @@ ecma_number_helper_binary_to_decimal (ECMA_NUMBER_CONVERSION_128BIT_INTEGER_ARG
10431043
*/
10441044
void
10451045
ecma_number_to_decimal (ecma_number_t num, /**< ecma-number */
1046-
uint64_t *out_digits_p, /**< out: digits */
1047-
int32_t *out_digits_num_p, /**< out: number of digits */
1048-
int32_t *out_decimal_exp_p) /**< out: decimal exponent */
1046+
uint64_t *out_digits_p, /**< [out] digits */
1047+
int32_t *out_digits_num_p, /**< [out] number of digits */
1048+
int32_t *out_decimal_exp_p) /**< [out] decimal exponent */
10491049
{
10501050
JERRY_ASSERT (!ecma_number_is_nan (num));
10511051
JERRY_ASSERT (!ecma_number_is_zero (num));

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ bool
104104
ecma_get_external_pointer_value (ecma_object_t *obj_p, /**< object to get property value from */
105105
ecma_internal_property_id_t id, /**< identifier of internal property
106106
* to get value from */
107-
ecma_external_pointer_t *out_pointer_p) /**< out: value of the external pointer */
107+
ecma_external_pointer_t *out_pointer_p) /**< [out] value of the external pointer */
108108
{
109109
JERRY_ASSERT (id == ECMA_INTERNAL_PROPERTY_NATIVE_CODE
110110
|| id == ECMA_INTERNAL_PROPERTY_NATIVE_HANDLE

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ ecma_number_pack (bool sign, /**< sign */
6464
*/
6565
static void
6666
ecma_number_unpack (ecma_number_t num, /**< ecma-number */
67-
bool *sign_p, /**< optional out: sign */
68-
uint32_t *biased_exp_p, /**< optional out: biased exponent */
69-
uint64_t *fraction_p) /**< optional out: fraction */
67+
bool *sign_p, /**< [out] sign (optional) */
68+
uint32_t *biased_exp_p, /**< [out] biased exponent (optional) */
69+
uint64_t *fraction_p) /**< [out] fraction (optional) */
7070
{
7171
const uint32_t fraction_pos = 0;
7272
const uint32_t biased_exp_pos = fraction_pos + ECMA_NUMBER_FRACTION_WIDTH;
@@ -150,9 +150,9 @@ ecma_number_pack (bool sign, /**< sign */
150150
*/
151151
static void
152152
ecma_number_unpack (ecma_number_t num, /**< ecma-number */
153-
bool *sign_p, /**< optional out: sign */
154-
uint32_t *biased_exp_p, /**< optional out: biased exponent */
155-
uint64_t *fraction_p) /**< optional out: fraction */
153+
bool *sign_p, /**< [out] sign (optional) */
154+
uint32_t *biased_exp_p, /**< [out] biased exponent (optional) */
155+
uint64_t *fraction_p) /**< [out] fraction (optional) */
156156
{
157157
const uint32_t fraction_pos = 0;
158158
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 */
362362
*/
363363
int32_t
364364
ecma_number_get_fraction_and_exponent (ecma_number_t num, /**< ecma-number */
365-
uint64_t *out_fraction_p, /**< out: fraction of the number */
366-
int32_t *out_exponent_p) /**< out: exponent of the number */
365+
uint64_t *out_fraction_p, /**< [out] fraction of the number */
366+
int32_t *out_exponent_p) /**< [out] exponent of the number */
367367
{
368368
JERRY_ASSERT (!ecma_number_is_nan (num));
369369

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -843,7 +843,7 @@ ecma_string_to_number (const ecma_string_t *str_p) /**< ecma-string */
843843
*/
844844
bool
845845
ecma_string_get_array_index (const ecma_string_t *str_p, /**< ecma-string */
846-
uint32_t *out_index_p) /**< out: index */
846+
uint32_t *out_index_p) /**< [out] index */
847847
{
848848
bool is_array_index = true;
849849
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
14521452
*/
14531453
static bool
14541454
ecma_is_string_magic_longpath (const ecma_string_t *string_p, /**< ecma-string */
1455-
lit_magic_string_id_t *out_id_p) /**< out: magic string's id */
1455+
lit_magic_string_id_t *out_id_p) /**< [out] magic string's id */
14561456
{
14571457
lit_utf8_byte_t utf8_string_buffer[LIT_MAGIC_STRING_LENGTH_LIMIT];
14581458

@@ -1473,7 +1473,7 @@ ecma_is_string_magic_longpath (const ecma_string_t *string_p, /**< ecma-string *
14731473
*/
14741474
static bool
14751475
ecma_is_ex_string_magic_longpath (const ecma_string_t *string_p, /**< ecma-string */
1476-
lit_magic_string_ex_id_t *out_id_p) /**< out: external magic string's id */
1476+
lit_magic_string_ex_id_t *out_id_p) /**< [out] external magic string's id */
14771477
{
14781478
lit_utf8_byte_t utf8_string_buffer[LIT_MAGIC_STRING_LENGTH_LIMIT];
14791479

@@ -1492,7 +1492,7 @@ ecma_is_ex_string_magic_longpath (const ecma_string_t *string_p, /**< ecma-strin
14921492
*/
14931493
bool
14941494
ecma_is_string_magic (const ecma_string_t *string_p, /**< ecma-string */
1495-
lit_magic_string_id_t *out_id_p) /**< out: magic string's id */
1495+
lit_magic_string_id_t *out_id_p) /**< [out] magic string's id */
14961496
{
14971497
if (string_p->container == ECMA_STRING_CONTAINER_MAGIC_STRING)
14981498
{
@@ -1525,7 +1525,7 @@ ecma_is_string_magic (const ecma_string_t *string_p, /**< ecma-string */
15251525
*/
15261526
bool
15271527
ecma_is_ex_string_magic (const ecma_string_t *string_p, /**< ecma-string */
1528-
lit_magic_string_ex_id_t *out_id_p) /**< out: external magic string's id */
1528+
lit_magic_string_ex_id_t *out_id_p) /**< [out] external magic string's id */
15291529
{
15301530
if (string_p->container == ECMA_STRING_CONTAINER_MAGIC_STRING_EX)
15311531
{

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,11 +235,11 @@ ecma_lcache_insert (ecma_object_t *object_p, /**< object */
235235
bool __attr_always_inline___
236236
ecma_lcache_lookup (ecma_object_t *object_p, /**< object */
237237
const ecma_string_t *prop_name_p, /**< property's name */
238-
ecma_property_t **prop_p_p) /**< out: if return value is true,
238+
ecma_property_t **prop_p_p) /**< [out] if return value is true,
239239
* then here will be pointer to property,
240240
* if the object contains property with specified name,
241241
* or, otherwise - NULL;
242-
* if return value is false,
242+
* if return value is false,
243243
* then the output parameter is not set */
244244
{
245245
#ifndef CONFIG_ECMA_LCACHE_DISABLE

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -925,7 +925,7 @@ ecma_date_set_internal_property (ecma_value_t this_arg, /**< this argument */
925925
* Insert leading zeros to a string of a number if needed.
926926
*/
927927
void
928-
ecma_date_insert_leading_zeros (ecma_string_t **str_p, /**< input/output string */
928+
ecma_date_insert_leading_zeros (ecma_string_t **str_p, /**< [in,out] ecma string */
929929
ecma_number_t num, /**< input number */
930930
uint32_t length) /**< length of string of number */
931931
{

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ ecma_builtin_helper_array_index_normalize (ecma_number_t index, /**< index */
328328
*/
329329
ecma_value_t
330330
ecma_builtin_helper_array_concat_value (ecma_object_t *obj_p, /**< array */
331-
uint32_t *length_p, /**< in-out: array's length */
331+
uint32_t *length_p, /**< [in,out] array's length */
332332
ecma_value_t value) /**< value to concat */
333333
{
334334
ecma_value_t ret_value = ecma_make_simple_value (ECMA_SIMPLE_VALUE_EMPTY);

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -567,7 +567,7 @@ ecma_op_from_property_descriptor (const ecma_property_descriptor_t *src_prop_des
567567
*/
568568
ecma_value_t
569569
ecma_op_to_property_descriptor (ecma_value_t obj_value, /**< object value */
570-
ecma_property_descriptor_t *out_prop_desc_p) /**< out: filled property descriptor
570+
ecma_property_descriptor_t *out_prop_desc_p) /**< [out] filled property descriptor
571571
if return value is normal
572572
empty completion value */
573573
{

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
*/
6666
ecma_value_t
6767
re_parse_regexp_flags (ecma_string_t *flags_str_p, /**< Input string with flags */
68-
uint16_t *flags_p) /**< Output: parsed flag bits */
68+
uint16_t *flags_p) /**< [out] parsed flag bits */
6969
{
7070
ecma_value_t ret_value = ecma_make_simple_value (ECMA_SIMPLE_VALUE_EMPTY);
7171

@@ -374,7 +374,7 @@ static ecma_value_t
374374
re_match_regexp (re_matcher_ctx_t *re_ctx_p, /**< RegExp matcher context */
375375
uint8_t *bc_p, /**< pointer to the current RegExp bytecode */
376376
lit_utf8_byte_t *str_p, /**< input string pointer */
377-
lit_utf8_byte_t **out_str_p) /**< Output: matching substring iterator */
377+
lit_utf8_byte_t **out_str_p) /**< [out] matching substring iterator */
378378
{
379379
ecma_value_t ret_value = ecma_make_simple_value (ECMA_SIMPLE_VALUE_EMPTY);
380380
re_opcode_t op;

‎jerry-core/jerry.c

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ jerry_api_create_string_value (jerry_api_string_t *value) /**< jerry_api_string_
371371
* just when it becomes unnecessary.
372372
*/
373373
static void
374-
jerry_api_convert_ecma_value_to_api_value (jerry_api_value_t *out_value_p, /**< out: api value */
374+
jerry_api_convert_ecma_value_to_api_value (jerry_api_value_t *out_value_p, /**< [out] api value */
375375
ecma_value_t value) /**< ecma value (undefined,
376376
* null, boolean, number,
377377
* string or object */
@@ -434,7 +434,7 @@ jerry_api_convert_ecma_value_to_api_value (jerry_api_value_t *out_value_p, /**<
434434
* the output ecma value should be freed with ecma_free_value when it becomes unnecessary.
435435
*/
436436
static void
437-
jerry_api_convert_api_value_to_ecma_value (ecma_value_t *out_value_p, /**< out: ecma value */
437+
jerry_api_convert_api_value_to_ecma_value (ecma_value_t *out_value_p, /**< [out] ecma value */
438438
const jerry_api_value_t *api_value_p) /**< value in Jerry API format */
439439
{
440440
switch (api_value_p->type)
@@ -520,7 +520,7 @@ jerry_api_convert_api_value_to_ecma_value (ecma_value_t *out_value_p, /**< out:
520520
* @return completion code
521521
*/
522522
static jerry_completion_code_t
523-
jerry_api_convert_eval_completion_to_retval (jerry_api_value_t *retval_p, /**< out: api value */
523+
jerry_api_convert_eval_completion_to_retval (jerry_api_value_t *retval_p, /**< [out] api value */
524524
ecma_value_t completion) /**< completion of 'eval'-mode
525525
* code execution */
526526
{
@@ -558,7 +558,7 @@ jerry_api_convert_eval_completion_to_retval (jerry_api_value_t *retval_p, /**< o
558558
*/
559559
ssize_t
560560
jerry_api_string_to_char_buffer (const jerry_api_string_t *string_p, /**< string descriptor */
561-
jerry_api_char_t *buffer_p, /**< output characters buffer */
561+
jerry_api_char_t *buffer_p, /**< [out] output characters buffer */
562562
ssize_t buffer_size) /**< size of output buffer */
563563
{
564564
jerry_assert_api_available ();
@@ -1116,7 +1116,7 @@ jerry_api_delete_object_field (jerry_api_object_t *object_p, /**< object to dele
11161116
*/
11171117
bool jerry_api_get_object_field_value (jerry_api_object_t *object_p, /**< object */
11181118
const jerry_api_char_t *field_name_p, /**< field name */
1119-
jerry_api_value_t *field_value_p) /**< out: field value */
1119+
jerry_api_value_t *field_value_p) /**< [out] field value */
11201120
{
11211121
return jerry_api_get_object_field_value_sz (object_p,
11221122
field_name_p,
@@ -1196,7 +1196,7 @@ bool
11961196
jerry_api_get_object_field_value_sz (jerry_api_object_t *object_p, /**< object */
11971197
const jerry_api_char_t *field_name_p, /**< name of the field */
11981198
jerry_api_size_t field_name_size, /**< size of field name in bytes */
1199-
jerry_api_value_t *field_value_p) /**< out: field value, if retrieved
1199+
jerry_api_value_t *field_value_p) /**< [out] field value, if retrieved
12001200
* successfully */
12011201
{
12021202
jerry_assert_api_available ();
@@ -1292,7 +1292,7 @@ jerry_api_set_object_field_value_sz (jerry_api_object_t *object_p, /**< object *
12921292
*/
12931293
bool
12941294
jerry_api_get_object_native_handle (jerry_api_object_t *object_p, /**< object to get handle from */
1295-
uintptr_t *out_handle_p) /**< out: handle value */
1295+
uintptr_t *out_handle_p) /**< [out] handle value */
12961296
{
12971297
jerry_assert_api_available ();
12981298

@@ -1452,7 +1452,7 @@ jerry_api_invoke_function (bool is_invoke_as_constructor, /**< true - invoke fun
14521452
* Construct new TypeError object
14531453
*/
14541454
static void
1455-
jerry_api_construct_type_error (jerry_api_value_t *retval_p) /**< out: value with constructed
1455+
jerry_api_construct_type_error (jerry_api_value_t *retval_p) /**< [out] value with constructed
14561456
* TypeError object */
14571457
{
14581458
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 */
15761576
size_t source_size, /**< length of source code */
15771577
bool is_direct, /**< perform eval invocation in direct mode */
15781578
bool is_strict, /**< perform eval as it is called from strict mode code */
1579-
jerry_api_value_t *retval_p) /**< out: returned value */
1579+
jerry_api_value_t *retval_p) /**< [out] returned value */
15801580
{
15811581
jerry_assert_api_available ();
15821582

@@ -1663,9 +1663,9 @@ jerry_cleanup (void)
16631663
* Get Jerry configured memory limits
16641664
*/
16651665
void
1666-
jerry_get_memory_limits (size_t *out_data_bss_brk_limit_p, /**< out: Jerry's maximum usage of
1666+
jerry_get_memory_limits (size_t *out_data_bss_brk_limit_p, /**< [out] Jerry's maximum usage of
16671667
* data + bss + brk sections */
1668-
size_t *out_stack_limit_p) /**< out: Jerry's maximum usage of stack */
1668+
size_t *out_stack_limit_p) /**< [out] Jerry's maximum usage of stack */
16691669
{
16701670
*out_data_bss_brk_limit_p = CONFIG_MEM_HEAP_AREA_SIZE + CONFIG_MEM_DATA_LIMIT_MINUS_HEAP_SIZE;
16711671
*out_stack_limit_p = CONFIG_MEM_STACK_LIMIT;
@@ -2295,7 +2295,7 @@ jerry_exec_snapshot (const void *snapshot_p, /**< snapshot */
22952295
* buffer could be freed after the call).
22962296
* Otherwise (if the flag is not set) - the buffer could only be
22972297
* freed after the engine stops (i.e. after call to jerry_cleanup). */
2298-
jerry_api_value_t *retval_p) /**< out: returned value (ECMA-262 'undefined' if
2298+
jerry_api_value_t *retval_p) /**< [out] returned value (ECMA-262 'undefined' if
22992299
* code is executed as global scope code) */
23002300
{
23012301
jerry_api_convert_ecma_value_to_api_value (retval_p, ecma_make_simple_value (ECMA_SIMPLE_VALUE_UNDEFINED));

0 commit comments

Comments
 (0)