Update Doxygen config file and fix Doxygen warnings #2324
Conversation
LaszloLango
added
bug
|
@zherczeg there are some TODOs in this patch where I was not sure what would be the appropriate comment. Could you help me to fix them? |
jerry-core/ecma/base/ecma-gc.c
Outdated
| @@ -55,6 +55,9 @@ | |||
|
|
|||
| /** | |||
| * Get next object in list of objects with same generation. | |||
| * | |||
| * @return pointer to the next ecma-object | |||
| * NULL - if there is not next ecma-object | |||
| #define EPSILON 0.0000001 | ||
|
|
||
| #if CONFIG_ECMA_NUMBER_TYPE == CONFIG_ECMA_NUMBER_FLOAT64 | ||
| /** | ||
| * Number.MAX_VALUE and Number.MIN_VALUE exponent parts while using 64 bit float representation | ||
| * Number.MAX_VALUE exponent parts while using 64 bit float representation. |
There was a problem hiding this comment.
parts while -> part when
Similar comments below.
| @@ -512,6 +512,8 @@ ecma_make_uint32_value (uint32_t uint32_number) /**< uint32 number to be encoded | |||
|
|
|||
| /** | |||
| * String value constructor | |||
| * | |||
| * @return ecma-value containing the constructed string | |||
There was a problem hiding this comment.
It does not construct a string. I think this comment is better:
@return ecma-value representation of the string argument
similar cases below
jerry-core/ecma/base/ecma-helpers.c
Outdated
| @@ -340,6 +360,9 @@ ecma_get_property_list (const ecma_object_t *object_p) /**< object or lexical en | |||
|
|
|||
| /** | |||
| * Get lexical environment's 'provideThis' property | |||
| * | |||
| * @return true - if has 'this' | |||
| @@ -125,6 +125,11 @@ ecma_builtin_number_prototype_helper_to_string (lit_utf8_byte_t *digits_p, /**< | |||
| return (lit_utf8_size_t) (p - to_digits_p); | |||
| } /* ecma_builtin_number_prototype_helper_to_string */ | |||
|
|
|||
| /** | |||
| * Helper function to convert floating point number in binary format to string. | |||
There was a problem hiding this comment.
Helper function to convert a binary floating point number to string
| * | ||
| * @param context_p TODO | ||
| * @param byte TODO | ||
| */ |
There was a problem hiding this comment.
Append byte to the end of the current byte code stream.
jerry-core/parser/js/js-parser.c
Outdated
| * | ||
| * @param page_p TODO | ||
| * @param offset TODO | ||
| */ |
There was a problem hiding this comment.
Forward iterator: move to the next byte code
jerry-core/parser/js/js-parser.c
Outdated
| * @param page_p TODO | ||
| * @param offset TODO | ||
| * @param real_offset TODO | ||
| */ |
There was a problem hiding this comment.
Forward iterator: move to the next byte code. Also updates the offset of the previous byte code.
jerry-core/vm/vm.c
Outdated
| * TODO | ||
| * | ||
| * @param destination TODO | ||
| */ |
There was a problem hiding this comment.
Read literal index from the byte code stream into destination.
| * When we are able to construct a function with similar speed, | ||
| * we can remove this macro. */ | ||
| * we can remove this macro. | ||
| */ |
There was a problem hiding this comment.
Get literal value by literal index.
A lot of warnings remained hibben because 'EXTRACT_ALL' was previously set to YES. JerryScript-DCO-1.0-Signed-off-by: László Langó [email protected]
LaszloLango
changed the title
|
@zherczeg thanks for the review, I've updated the PR. |
| /** | ||
| * One character long token (e.g. comma). | ||
| * | ||
| * @param char1 character |
There was a problem hiding this comment.
Do we use at-param with macro functions?
There was a problem hiding this comment.
Yes, we do. There are a few examples in the current master. Unfortunately we cannot use inline comments for macro functions parameters.
There was a problem hiding this comment.
Few examples do not make a rule. I found far less positive examples than negative, so I would rather remove these.
There was a problem hiding this comment.
Doxygen will warn if I remove these.
|
LGTM |
A lot of warnings remained hibben because 'EXTRACT_ALL' was previously set to YES.
JerryScript-DCO-1.0-Signed-off-by: László Langó [email protected]