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
This commit is contained in:
László Langó
2016-02-24 15:51:46 +01:00
parent d47c36f1b4
commit e14d0b8942
20 changed files with 66 additions and 66 deletions
@@ -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));
@@ -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
+8 -8
View File
@@ -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));
+5 -5
View File
@@ -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)
{
+2 -2
View File
@@ -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