Skip to content

Eliminating doxygen warnings by fixing the documentation #889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 16, 2016
Merged

Eliminating doxygen warnings by fixing the documentation #889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion jerry-core/ecma/base/ecma-init-finalize.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
*/

/**
* \addtogroup ecmainitfinalize Initialization and finalization of ECMA
* \addtogroup ecmainitfinalize Initialization and finalization of ECMA components
* @{
*/

Expand Down
8 changes: 4 additions & 4 deletions jerry-core/ecma/builtin-objects/ecma-builtin-array-prototype.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ ecma_builtin_array_prototype_object_concat (ecma_value_t this_arg, /**< this arg
* Returned value must be freed with ecma_free_completion_value.
*/
static ecma_completion_value_t
ecma_op_array_get_separator_string (ecma_value_t separator) /** < possible separator */
ecma_op_array_get_separator_string (ecma_value_t separator) /**< possible separator */
{
if (ecma_is_value_undefined (separator))
{
Expand All @@ -318,8 +318,8 @@ ecma_op_array_get_separator_string (ecma_value_t separator) /** < possible separ
* Returned value must be freed with ecma_free_completion_value.
*/
static ecma_completion_value_t
ecma_op_array_get_to_string_at_index (ecma_object_t *obj_p, /** < this object */
uint32_t index) /** < array index */
ecma_op_array_get_to_string_at_index (ecma_object_t *obj_p, /**< this object */
uint32_t index) /**< array index */
{
ecma_completion_value_t ret_value = ecma_make_empty_completion_value ();
ecma_string_t *index_string_p = ecma_new_ecma_string_from_uint32 (index);
Expand Down Expand Up @@ -357,7 +357,7 @@ ecma_op_array_get_to_string_at_index (ecma_object_t *obj_p, /** < this object */
*/
static ecma_completion_value_t
ecma_builtin_array_prototype_join (const ecma_value_t this_arg, /**< this argument */
const ecma_value_t separator_arg) /** < separator argument */
const ecma_value_t separator_arg) /**< separator argument */
{
ecma_completion_value_t ret_value = ecma_make_empty_completion_value ();

Expand Down
4 changes: 2 additions & 2 deletions jerry-core/ecma/builtin-objects/ecma-builtin-function.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ ecma_builtin_function_dispatch_call (const ecma_value_t *arguments_list_p, /**<
* Returned value must be freed with ecma_free_completion_value.
*/
static ecma_completion_value_t
ecma_builtin_function_helper_get_function_expression (const ecma_value_t *arguments_list_p, /** < arguments list */
ecma_length_t arguments_list_len) /** < number of arguments */
ecma_builtin_function_helper_get_function_expression (const ecma_value_t *arguments_list_p, /**< arguments list */
ecma_length_t arguments_list_len) /**< number of arguments */
{
JERRY_ASSERT (arguments_list_len == 0 || arguments_list_p != NULL);

Expand Down
4 changes: 2 additions & 2 deletions jerry-core/ecma/builtin-objects/ecma-builtin-global.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@
*
* The routine converts all of its arguments to strings and outputs them using 'printf'.
*
* Code points, with except of <NUL> character, that are representable with one utf8-byte
* are outputted as is, using '%c' format argument, and other code points are outputted as '\uhhll',
* Code points, with except of NUL character, that are representable with one utf8-byte
* are outputted as is, using "%c" format argument, and other code points are outputted as "\uhhll",
* where hh and ll are values of code point's high and low bytes, correspondingly.
*
* @return completion value
Expand Down
10 changes: 5 additions & 5 deletions jerry-core/ecma/builtin-objects/ecma-builtin-helpers.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ ecma_builtin_helper_object_to_string (const ecma_value_t this_arg) /**< this arg
* Returned value must be freed with ecma_free_completion_value.
*/
ecma_completion_value_t
ecma_builtin_helper_get_to_locale_string_at_index (ecma_object_t *obj_p, /** < this object */
uint32_t index) /** < array index */
ecma_builtin_helper_get_to_locale_string_at_index (ecma_object_t *obj_p, /**< this object */
uint32_t index) /**< array index */
{
ecma_completion_value_t ret_value = ecma_make_empty_completion_value ();
ecma_string_t *index_string_p = ecma_new_ecma_string_from_uint32 (index);
Expand Down Expand Up @@ -196,8 +196,8 @@ ecma_builtin_helper_get_to_locale_string_at_index (ecma_object_t *obj_p, /** < t
* Returned value must be freed with ecma_free_completion_value.
*/
ecma_completion_value_t
ecma_builtin_helper_object_get_properties (ecma_object_t *obj_p, /** < object */
bool only_enumerable_properties) /** < list enumerable properties? */
ecma_builtin_helper_object_get_properties (ecma_object_t *obj_p, /**< object */
bool only_enumerable_properties) /**< list enumerable properties? */
{
JERRY_ASSERT (obj_p != NULL);

Expand Down Expand Up @@ -564,7 +564,7 @@ ecma_builtin_helper_string_find_index (ecma_string_t *original_str_p, /**< index
ecma_string_t *search_str_p, /**< string's length */
bool first_index, /**< whether search for first (t) or last (f) index */
ecma_length_t start_pos, /**< start position */
ecma_length_t *ret_index_p) /**> position found in original string */
ecma_length_t *ret_index_p) /**< position found in original string */
{
bool match_found = false;

Expand Down
2 changes: 1 addition & 1 deletion jerry-core/ecma/builtin-objects/ecma-builtin-json.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,7 @@ ecma_builtin_json_parse_value (ecma_json_token_t *token_p) /**< token argument *
static ecma_completion_value_t
ecma_builtin_json_walk (ecma_object_t *reviver_p, /**< reviver function */
ecma_object_t *holder_p, /**< holder object */
ecma_string_t *name_p) /** < property name */
ecma_string_t *name_p) /**< property name */
{
JERRY_ASSERT (reviver_p);
JERRY_ASSERT (holder_p);
Expand Down
2 changes: 1 addition & 1 deletion jerry-core/ecma/builtin-objects/ecma-builtin-regexp-prototype.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
* \addtogroup ecmabuiltins
* @{
*
* \addtogroup regexp ECMA RegExp.prototype object built-in
* \addtogroup regexpprototype ECMA RegExp.prototype object built-in
* @{
*/

Expand Down
2 changes: 1 addition & 1 deletion jerry-core/ecma/operations/ecma-conversion.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
/** \addtogroup ecma ECMA
* @{
*
* \addtogroup ecmaconversion ECMA conversion
* \addtogroup ecmaconversion ECMA conversion routines
* @{
*/

Expand Down
4 changes: 2 additions & 2 deletions jerry-core/ecma/operations/ecma-objects.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -501,8 +501,8 @@ ecma_op_object_has_instance (ecma_object_t *obj_p, /**< the 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 */
ecma_object_t *target_p) /** < target object */
ecma_op_object_is_prototype_of (ecma_object_t *base_p, /**< base object */
ecma_object_t *target_p) /**< target object */
{
do
{
Expand Down
2 changes: 1 addition & 1 deletion jerry-core/ecma/operations/ecma-regexp-object.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1176,7 +1176,7 @@ void
re_set_result_array_properties (ecma_object_t *array_obj_p, /**< result array */
ecma_string_t *input_str_p, /**< input string */
uint32_t num_of_elements, /**< Number of array elements */
int32_t index) /** index of matching */
int32_t index) /**< index of matching */
{
/* Set index property of the result array */
ecma_string_t *result_prop_str_p = ecma_get_magic_string (LIT_MAGIC_STRING_INDEX);
Expand Down
2 changes: 1 addition & 1 deletion jerry-core/jerry-port.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
# define EXTERN_C
#endif /* !__cplusplus */

/** \addtogroup jerry Jerry engine port
/** \addtogroup jerry_port Jerry engine port
* @{
*/

Expand Down
2 changes: 1 addition & 1 deletion jerry-core/jrt/jrt-fatals.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ void __noreturn
jerry_assert_fail (const char *assertion, /**< assertion condition string */
const char *file, /**< file name */
const char *function, /**< function name */
const uint32_t line) /** line */
const uint32_t line) /**< line */
{
#if !defined (JERRY_NDEBUG) || !defined (JERRY_DISABLE_HEAVY_DEBUG)
printf ("ICE: Assertion '%s' failed at %s(%s):%lu.\n",
Expand Down
8 changes: 4 additions & 4 deletions jerry-core/jrt/jrt.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,16 +199,16 @@ extern void __noreturn jerry_fatal (jerry_fatal_code_t);
*/

/**
* Aligns @value to @alignment.
* Aligns @a value to @a alignment.
*
* Returns maximum positive value, that divides @alignment and is less than or equal to @value
* Returns maximum positive value, that divides @a alignment and is less than or equal to @a value
*/
#define JERRY_ALIGNDOWN(value, alignment) ((alignment) * ((value) / (alignment)))

/**
* Aligns @value to @alignment.
* Aligns @a value to @a alignment.
*
* Returns minimum positive value, that divides @alignment and is more than or equal to @value
* Returns minimum positive value, that divides @a alignment and is more than or equal to @a value
*/
#define JERRY_ALIGNUP(value, alignment) ((alignment) * (((value) + (alignment) - 1) / (alignment)))

Expand Down
2 changes: 1 addition & 1 deletion jerry-core/lit/lit-char-helpers.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ lit_char_hex_to_int (ecma_char_t c) /**< code unit, corresponding to
bool
lit_read_code_point_from_hex (lit_utf8_byte_t *buf_p, /**< buffer with characters */
lit_utf8_size_t number_of_characters, /**< number of characters to be read */
lit_code_point_t *out_code_point_p) /**< @out: decoded result */
lit_code_point_t *out_code_point_p) /**< [out] decoded result */
{
lit_code_point_t code_point = 0;

Expand Down
2 changes: 1 addition & 1 deletion jerry-core/lit/lit-literal-storage.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ lit_storage_create_magic_literal_ex (rcs_record_set_t *rec_set_p, /**< recordset
* @return pointer to the created record
*/
rcs_record_t *
lit_storage_create_number_literal (rcs_record_set_t *rec_set_p, /** recordset */
lit_storage_create_number_literal (rcs_record_set_t *rec_set_p, /**< recordset */
ecma_number_t num) /**< numeric value */
{
const size_t record_size = RCS_NUMBER_HEADER_SIZE + sizeof (ecma_number_t);
Expand Down
14 changes: 7 additions & 7 deletions jerry-core/lit/lit-strings.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ convert_code_point_to_high_surrogate (lit_code_point_t code_point) /**< code poi
* @return next code unit
*/
ecma_char_t
lit_utf8_iterator_peek_next (const lit_utf8_iterator_t *iter_p) /**< @in: utf-8 string iterator */
lit_utf8_iterator_peek_next (const lit_utf8_iterator_t *iter_p) /**< [in] utf-8 string iterator */
{
JERRY_ASSERT (!lit_utf8_iterator_is_eos (iter_p));

Expand Down Expand Up @@ -377,7 +377,7 @@ lit_utf8_iterator_peek_next (const lit_utf8_iterator_t *iter_p) /**< @in: utf-8
* Increment iterator to point to next code unit
*/
void
lit_utf8_iterator_incr (lit_utf8_iterator_t *iter_p) /**< @in-out: utf-8 string iterator */
lit_utf8_iterator_incr (lit_utf8_iterator_t *iter_p) /**< [in,out] utf-8 string iterator */
{
lit_utf8_iterator_read_next (iter_p);
} /* lit_utf8_iterator_incr */
Expand All @@ -386,7 +386,7 @@ lit_utf8_iterator_incr (lit_utf8_iterator_t *iter_p) /**< @in-out: utf-8 string
* Skip specified number of code units
*/
void
lit_utf8_iterator_advance (lit_utf8_iterator_t *iter_p, /**< in-out: iterator */
lit_utf8_iterator_advance (lit_utf8_iterator_t *iter_p, /**< [in,out] iterator */
ecma_length_t chars_count) /**< number of code units to skip */
{
while (chars_count--)
Expand All @@ -401,7 +401,7 @@ lit_utf8_iterator_advance (lit_utf8_iterator_t *iter_p, /**< in-out: iterator */
* @return next code unit
*/
ecma_char_t
lit_utf8_iterator_read_next (lit_utf8_iterator_t *iter_p) /**< @in-out: utf-8 string iterator */
lit_utf8_iterator_read_next (lit_utf8_iterator_t *iter_p) /**< [in,out] utf-8 string iterator */
{
JERRY_ASSERT (!lit_utf8_iterator_is_eos (iter_p));

Expand Down Expand Up @@ -491,7 +491,7 @@ lit_utf8_string_length (const lit_utf8_byte_t *utf8_buf_p, /**< utf-8 string */
lit_utf8_size_t
lit_read_code_point_from_utf8 (const lit_utf8_byte_t *buf_p, /**< buffer with characters */
lit_utf8_size_t buf_size, /**< size of the buffer in bytes */
lit_code_point_t *code_point) /**< @out: code point */
lit_code_point_t *code_point) /**< [out] code point */
{
JERRY_ASSERT (buf_p && buf_size);

Expand Down Expand Up @@ -543,7 +543,7 @@ lit_read_code_point_from_utf8 (const lit_utf8_byte_t *buf_p, /**< buffer with ch
*/
lit_utf8_size_t
lit_read_code_unit_from_utf8 (const lit_utf8_byte_t *buf_p, /**< buffer with characters */
ecma_char_t *code_point) /**< @out: code point */
ecma_char_t *code_point) /**< [out] code point */
{
JERRY_ASSERT (buf_p);

Expand Down Expand Up @@ -586,7 +586,7 @@ lit_read_code_unit_from_utf8 (const lit_utf8_byte_t *buf_p, /**< buffer with cha
*/
lit_utf8_size_t
lit_read_prev_code_unit_from_utf8 (const lit_utf8_byte_t *buf_p, /**< buffer with characters */
ecma_char_t *code_point) /**< @out: code point */
ecma_char_t *code_point) /**< [out] code point */
{
JERRY_ASSERT (buf_p);

Expand Down
6 changes: 6 additions & 0 deletions jerry-core/parser/js/common.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,4 +164,10 @@ void util_print_literal (lexer_literal_t *);
#define PARSER_INLINE inline
#define PARSER_NOINLINE __attribute__ ((noinline))

/**
* @}
* @}
* @}
*/

#endif /* !COMMON_H */
100 changes: 50 additions & 50 deletions jerry-core/parser/js/js-lexer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,15 @@ typedef enum
#define LEXER_IS_UNARY_LVALUE_OP_TOKEN(token_type) \
((token_type) >= LEXER_KEYW_DELETE && (token_type) <= LEXER_DECREASE)

LEXER_PLUS, /**< + */
LEXER_NEGATE, /**< - */
LEXER_LOGICAL_NOT, /**< ! */
LEXER_BIT_NOT, /**< ~ */
LEXER_PLUS, /**< "+" */
LEXER_NEGATE, /**< "-" */
LEXER_LOGICAL_NOT, /**< "!" */
LEXER_BIT_NOT, /**< "~" */
LEXER_KEYW_VOID, /**< void */
LEXER_KEYW_TYPEOF, /**< typeof */
LEXER_KEYW_DELETE, /**< delete */
LEXER_INCREASE, /**< ++ */
LEXER_DECREASE, /**< -- */
LEXER_INCREASE, /**< "++" */
LEXER_DECREASE, /**< "--" */

/* Binary operators
* IMPORTANT: update CBC_BINARY_OP_TOKEN_TO_OPCODE,
Expand All @@ -69,53 +69,53 @@ typedef enum
((token_type) >= LEXER_ASSIGN && (token_type) <= LEXER_ASSIGN_BIT_XOR)
#define LEXER_FIRST_BINARY_OP LEXER_ASSIGN

LEXER_ASSIGN, /**< = (prec: 3) */
LEXER_ASSIGN_ADD, /**< += (prec: 3) */
LEXER_ASSIGN_SUBTRACT, /**< -= (prec: 3) */
LEXER_ASSIGN_MULTIPLY, /**< *= (prec: 3) */
LEXER_ASSIGN_DIVIDE, /**< /= (prec: 3) */
LEXER_ASSIGN_MODULO, /**< %= (prec: 3) */
LEXER_ASSIGN_LEFT_SHIFT, /**< <<= (prec: 3) */
LEXER_ASSIGN_RIGHT_SHIFT, /**< >>= (prec: 3) */
LEXER_ASSIGN_UNS_RIGHT_SHIFT, /**< >>>= (prec: 3) */
LEXER_ASSIGN_BIT_AND, /**< &= (prec: 3) */
LEXER_ASSIGN_BIT_OR, /**< |= (prec: 3) */
LEXER_ASSIGN_BIT_XOR, /**< ^= (prec: 3) */
LEXER_QUESTION_MARK, /**< ? (prec: 4) */
LEXER_LOGICAL_OR, /**< || (prec: 5) */
LEXER_LOGICAL_AND, /**< && (prec: 6) */
LEXER_BIT_OR, /**< | (prec: 7) */
LEXER_BIT_XOR, /**< ^ (prec: 8) */
LEXER_BIT_AND, /**< & (prec: 9) */
LEXER_EQUAL, /**< == (prec: 10) */
LEXER_NOT_EQUAL, /**< != (prec: 10) */
LEXER_STRICT_EQUAL, /**< === (prec: 10) */
LEXER_STRICT_NOT_EQUAL, /**< !== (prec: 10) */
LEXER_LESS, /**< < (prec: 11) */
LEXER_GREATER, /**< > (prec: 11) */
LEXER_LESS_EQUAL, /**< <= (prec: 11) */
LEXER_GREATER_EQUAL, /**< >= (prec: 11) */
LEXER_ASSIGN, /**< "=" (prec: 3) */
LEXER_ASSIGN_ADD, /**< "+=" (prec: 3) */
LEXER_ASSIGN_SUBTRACT, /**< "-=" (prec: 3) */
LEXER_ASSIGN_MULTIPLY, /**< "*=" (prec: 3) */
LEXER_ASSIGN_DIVIDE, /**< "/=" (prec: 3) */
LEXER_ASSIGN_MODULO, /**< "%=" (prec: 3) */
LEXER_ASSIGN_LEFT_SHIFT, /**< "<<=" (prec: 3) */
LEXER_ASSIGN_RIGHT_SHIFT, /**< ">>=" (prec: 3) */
LEXER_ASSIGN_UNS_RIGHT_SHIFT, /**< ">>>=" (prec: 3) */
LEXER_ASSIGN_BIT_AND, /**< "&=" (prec: 3) */
LEXER_ASSIGN_BIT_OR, /**< "|=" (prec: 3) */
LEXER_ASSIGN_BIT_XOR, /**< "^=" (prec: 3) */
LEXER_QUESTION_MARK, /**< "?" (prec: 4) */
LEXER_LOGICAL_OR, /**< "||" (prec: 5) */
LEXER_LOGICAL_AND, /**< "&&" (prec: 6) */
LEXER_BIT_OR, /**< "|" (prec: 7) */
LEXER_BIT_XOR, /**< "^" (prec: 8) */
LEXER_BIT_AND, /**< "&" (prec: 9) */
LEXER_EQUAL, /**< "==" (prec: 10) */
LEXER_NOT_EQUAL, /**< "!=" (prec: 10) */
LEXER_STRICT_EQUAL, /**< "===" (prec: 10) */
LEXER_STRICT_NOT_EQUAL, /**< "!==" (prec: 10) */
LEXER_LESS, /**< "<" (prec: 11) */
LEXER_GREATER, /**< ">" (prec: 11) */
LEXER_LESS_EQUAL, /**< "<=" (prec: 11) */
LEXER_GREATER_EQUAL, /**< ">=" (prec: 11) */
LEXER_KEYW_IN, /**< in (prec: 11) */
LEXER_KEYW_INSTANCEOF, /**< instanceof (prec: 11) */
LEXER_LEFT_SHIFT, /**< << (prec: 12) */
LEXER_RIGHT_SHIFT, /**< >> (prec: 12) */
LEXER_UNS_RIGHT_SHIFT, /**< >>> (prec: 12) */
LEXER_ADD, /**< + (prec: 13) */
LEXER_SUBTRACT, /**< - (prec: 13) */
LEXER_MULTIPLY, /**< * (prec: 14) */
LEXER_DIVIDE, /**< / (prec: 14) */
LEXER_MODULO, /**< % (prec: 14) */
LEXER_LEFT_SHIFT, /**< "<<" (prec: 12) */
LEXER_RIGHT_SHIFT, /**< ">>" (prec: 12) */
LEXER_UNS_RIGHT_SHIFT, /**< ">>>" (prec: 12) */
LEXER_ADD, /**< "+" (prec: 13) */
LEXER_SUBTRACT, /**< "-" (prec: 13) */
LEXER_MULTIPLY, /**< "*" (prec: 14) */
LEXER_DIVIDE, /**< "/" (prec: 14) */
LEXER_MODULO, /**< "%" (prec: 14) */

LEXER_LEFT_BRACE, /**< { */
LEXER_LEFT_PAREN, /**< ( */
LEXER_LEFT_SQUARE, /**< [ */
LEXER_RIGHT_BRACE, /**< } */
LEXER_RIGHT_PAREN, /**<_) */
LEXER_RIGHT_SQUARE, /**< ] */
LEXER_DOT, /**< . */
LEXER_SEMICOLON, /**< ; */
LEXER_COLON, /**< : */
LEXER_COMMA, /**< , */
LEXER_LEFT_BRACE, /**< "{" */
LEXER_LEFT_PAREN, /**< "(" */
LEXER_LEFT_SQUARE, /**< "[" */
LEXER_RIGHT_BRACE, /**< "}" */
LEXER_RIGHT_PAREN, /**<_")" */
LEXER_RIGHT_SQUARE, /**< "]" */
LEXER_DOT, /**< "." */
LEXER_SEMICOLON, /**< ";" */
LEXER_COLON, /**< ":" */
LEXER_COMMA, /**< "," */

LEXER_KEYW_BREAK, /**< break */
LEXER_KEYW_DO, /**< do */
Expand Down
Loading