Skip to content

Commit 0d7ea70

Browse files
committed
Eliminating doxygen warnings by fixing the documentation
* Fix "end of file while inside a group" doxygen warnings. * Fix "unknown command" doxygen warnings caused by incorrect argument references. Instead of `@foo`, `@a foo` is the proper format. * Fix "unknown command" doxygen warnings caused by incorrect parameter direction specifications. Instead of `@in`, `@out`, and `@in-out`, `[in]`, `[out]`, and `[in,out]` are the proper formats. * Wrapping special characters in quotes to avoid doxygen confusion. Raw pipe, semicolon, dot, backslash, etc. characters can drive doxygen into various misinterpretations and warnings. E.g.: ``` End of list marker found without any preceding list items Found unknown command ``` Putting quotes around such text snipets eliminates the errors. * Fix the documentation of `ecma_builtin_global_object_print`. Raw <> and \ sequences confused doxygen in various ways (it tried to interpret them as XML tags and doxygen commands). * Fix "ignoring title that does not match old title" doxygen warnings. At some places, the group titles were out of sync, at others, the group names were incorrect. * Fix "parameters are not documented" doxygen warnings. Fixing various typos in the inline parameter documentations (`/*`, `/**`, `/** <`, and `/**>` are all considered incorrect, the right format is `/**<`). JerryScript-DCO-1.0-Signed-off-by: Akos Kiss [email protected]
1 parent ed12df5 commit 0d7ea70

25 files changed

+113
-101
lines changed

jerry-core/ecma/base/ecma-init-finalize.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
*/
2222

2323
/**
24-
* \addtogroup ecmainitfinalize Initialization and finalization of ECMA
24+
* \addtogroup ecmainitfinalize Initialization and finalization of ECMA components
2525
* @{
2626
*/
2727

jerry-core/ecma/builtin-objects/ecma-builtin-array-prototype.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ ecma_builtin_array_prototype_object_concat (ecma_value_t this_arg, /**< this arg
295295
* Returned value must be freed with ecma_free_completion_value.
296296
*/
297297
static ecma_completion_value_t
298-
ecma_op_array_get_separator_string (ecma_value_t separator) /** < possible separator */
298+
ecma_op_array_get_separator_string (ecma_value_t separator) /**< possible separator */
299299
{
300300
if (ecma_is_value_undefined (separator))
301301
{
@@ -318,8 +318,8 @@ ecma_op_array_get_separator_string (ecma_value_t separator) /** < possible separ
318318
* Returned value must be freed with ecma_free_completion_value.
319319
*/
320320
static ecma_completion_value_t
321-
ecma_op_array_get_to_string_at_index (ecma_object_t *obj_p, /** < this object */
322-
uint32_t index) /** < array index */
321+
ecma_op_array_get_to_string_at_index (ecma_object_t *obj_p, /**< this object */
322+
uint32_t index) /**< array index */
323323
{
324324
ecma_completion_value_t ret_value = ecma_make_empty_completion_value ();
325325
ecma_string_t *index_string_p = ecma_new_ecma_string_from_uint32 (index);
@@ -357,7 +357,7 @@ ecma_op_array_get_to_string_at_index (ecma_object_t *obj_p, /** < this object */
357357
*/
358358
static ecma_completion_value_t
359359
ecma_builtin_array_prototype_join (const ecma_value_t this_arg, /**< this argument */
360-
const ecma_value_t separator_arg) /** < separator argument */
360+
const ecma_value_t separator_arg) /**< separator argument */
361361
{
362362
ecma_completion_value_t ret_value = ecma_make_empty_completion_value ();
363363

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ ecma_builtin_function_dispatch_call (const ecma_value_t *arguments_list_p, /**<
6565
* Returned value must be freed with ecma_free_completion_value.
6666
*/
6767
static ecma_completion_value_t
68-
ecma_builtin_function_helper_get_function_expression (const ecma_value_t *arguments_list_p, /** < arguments list */
69-
ecma_length_t arguments_list_len) /** < number of arguments */
68+
ecma_builtin_function_helper_get_function_expression (const ecma_value_t *arguments_list_p, /**< arguments list */
69+
ecma_length_t arguments_list_len) /**< number of arguments */
7070
{
7171
JERRY_ASSERT (arguments_list_len == 0 || arguments_list_p != NULL);
7272

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@
5353
*
5454
* The routine converts all of its arguments to strings and outputs them using 'printf'.
5555
*
56-
* Code points, with except of <NUL> character, that are representable with one utf8-byte
57-
* are outputted as is, using '%c' format argument, and other code points are outputted as '\uhhll',
56+
* Code points, with except of NUL character, that are representable with one utf8-byte
57+
* are outputted as is, using "%c" format argument, and other code points are outputted as "\uhhll",
5858
* where hh and ll are values of code point's high and low bytes, correspondingly.
5959
*
6060
* @return completion value

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,8 @@ ecma_builtin_helper_object_to_string (const ecma_value_t this_arg) /**< this arg
124124
* Returned value must be freed with ecma_free_completion_value.
125125
*/
126126
ecma_completion_value_t
127-
ecma_builtin_helper_get_to_locale_string_at_index (ecma_object_t *obj_p, /** < this object */
128-
uint32_t index) /** < array index */
127+
ecma_builtin_helper_get_to_locale_string_at_index (ecma_object_t *obj_p, /**< this object */
128+
uint32_t index) /**< array index */
129129
{
130130
ecma_completion_value_t ret_value = ecma_make_empty_completion_value ();
131131
ecma_string_t *index_string_p = ecma_new_ecma_string_from_uint32 (index);
@@ -196,8 +196,8 @@ ecma_builtin_helper_get_to_locale_string_at_index (ecma_object_t *obj_p, /** < t
196196
* Returned value must be freed with ecma_free_completion_value.
197197
*/
198198
ecma_completion_value_t
199-
ecma_builtin_helper_object_get_properties (ecma_object_t *obj_p, /** < object */
200-
bool only_enumerable_properties) /** < list enumerable properties? */
199+
ecma_builtin_helper_object_get_properties (ecma_object_t *obj_p, /**< object */
200+
bool only_enumerable_properties) /**< list enumerable properties? */
201201
{
202202
JERRY_ASSERT (obj_p != NULL);
203203

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -608,7 +608,7 @@ ecma_builtin_json_parse_value (ecma_json_token_t *token_p) /**< token argument *
608608
static ecma_completion_value_t
609609
ecma_builtin_json_walk (ecma_object_t *reviver_p, /**< reviver function */
610610
ecma_object_t *holder_p, /**< holder object */
611-
ecma_string_t *name_p) /** < property name */
611+
ecma_string_t *name_p) /**< property name */
612612
{
613613
JERRY_ASSERT (reviver_p);
614614
JERRY_ASSERT (holder_p);

jerry-core/ecma/builtin-objects/ecma-builtin-regexp-prototype.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
* \addtogroup ecmabuiltins
4242
* @{
4343
*
44-
* \addtogroup regexp ECMA RegExp.prototype object built-in
44+
* \addtogroup regexpprototype ECMA RegExp.prototype object built-in
4545
* @{
4646
*/
4747

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
/** \addtogroup ecma ECMA
2323
* @{
2424
*
25-
* \addtogroup ecmaconversion ECMA conversion
25+
* \addtogroup ecmaconversion ECMA conversion routines
2626
* @{
2727
*/
2828

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -501,8 +501,8 @@ ecma_op_object_has_instance (ecma_object_t *obj_p, /**< the object */
501501
* false if the target object is not prototype of the base object
502502
*/
503503
bool
504-
ecma_op_object_is_prototype_of (ecma_object_t *base_p, /** < base object */
505-
ecma_object_t *target_p) /** < target object */
504+
ecma_op_object_is_prototype_of (ecma_object_t *base_p, /**< base object */
505+
ecma_object_t *target_p) /**< target object */
506506
{
507507
do
508508
{

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1176,7 +1176,7 @@ void
11761176
re_set_result_array_properties (ecma_object_t *array_obj_p, /**< result array */
11771177
ecma_string_t *input_str_p, /**< input string */
11781178
uint32_t num_of_elements, /**< Number of array elements */
1179-
int32_t index) /** index of matching */
1179+
int32_t index) /**< index of matching */
11801180
{
11811181
/* Set index property of the result array */
11821182
ecma_string_t *result_prop_str_p = ecma_get_magic_string (LIT_MAGIC_STRING_INDEX);

0 commit comments

Comments
 (0)