diff options
| author | Máté Tokodi <mate.tokodi@szteszoftver.hu> | 2023-11-15 09:49:04 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-15 09:49:04 +0100 |
| commit | ff9ff8f36c967890b5ebb240d9fa90d6e351aa01 (patch) | |
| tree | 30441be6d50401d92ccbde9db18b1ff7aa0a5a2b /jerry-core/ecma/base/ecma-helpers-value.c | |
| parent | bc408b159b9de16cb3b8fe84f683c561e2d26000 (diff) | |
Update doxygen and fix documentation (#5106)
Update Doxyfile to version 1.9.1
Re-enable doxygen CI checker
Fix some regular comments that should have been doc comments
Document void return types for some inline functions explicitly
Move start of some doxygen groups so they are included always, and not left
out of certain ifdefs
Ignore some doxygen warnings:
Member (function) is not documented in headers
Documented empty return type in headers
Argument has multiple @param documentation sections
JerryScript-DCO-1.0-Signed-off-by: Máté Tokodi mate.tokodi@szteszoftver.hu
Diffstat (limited to 'jerry-core/ecma/base/ecma-helpers-value.c')
| -rw-r--r-- | jerry-core/ecma/base/ecma-helpers-value.c | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/jerry-core/ecma/base/ecma-helpers-value.c b/jerry-core/ecma/base/ecma-helpers-value.c index cc79baa9..33c7317e 100644 --- a/jerry-core/ecma/base/ecma-helpers-value.c +++ b/jerry-core/ecma/base/ecma-helpers-value.c @@ -939,6 +939,8 @@ ecma_copy_value_if_not_object (ecma_value_t value) /**< value description */ /** * Increase reference counter of a value if it is an object. + * + * @return void */ extern inline void JERRY_ATTR_ALWAYS_INLINE ecma_ref_if_object (ecma_value_t value) /**< value description */ @@ -951,6 +953,8 @@ ecma_ref_if_object (ecma_value_t value) /**< value description */ /** * Decrease reference counter of a value if it is an object. + * + * @return void */ extern inline void JERRY_ATTR_ALWAYS_INLINE ecma_deref_if_object (ecma_value_t value) /**< value description */ @@ -1136,6 +1140,8 @@ ecma_free_value (ecma_value_t value) /**< value description */ * faster for direct values since no function call is performed. * It also increases the binary size so it is recommended for * critical code paths only. + * + * @return void */ extern inline void JERRY_ATTR_ALWAYS_INLINE ecma_fast_free_value (ecma_value_t value) /**< value description */ @@ -1160,6 +1166,8 @@ ecma_free_value_if_not_object (ecma_value_t value) /**< value description */ /** * Free an ecma-value object + * + * @return void */ extern inline void JERRY_ATTR_ALWAYS_INLINE ecma_free_object (ecma_value_t value) /**< value description */ @@ -1169,6 +1177,8 @@ ecma_free_object (ecma_value_t value) /**< value description */ /** * Free an ecma-value number + * + * @return void */ extern inline void JERRY_ATTR_ALWAYS_INLINE ecma_free_number (ecma_value_t value) /**< value description */ |