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 [email protected]
This commit is contained in:
1 parent
bc408b159b
commit
ff9ff8f36c
31 files changed
+512
-208
No files matched your search
@@ -3267,6 +3267,8 @@ ecma_op_ordinary_object_is_extensible (ecma_object_t *object_p) /**< object */
|
||||
|
||||
/**
|
||||
* Set value of [[Extensible]] object's internal property.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
void JERRY_ATTR_NOINLINE
|
||||
ecma_op_ordinary_object_prevent_extensions (ecma_object_t *object_p) /**< object */
|
||||
|
||||
@@ -68,6 +68,8 @@ ecma_promise_get_result (ecma_object_t *obj_p) /**< points to promise object */
|
||||
|
||||
/**
|
||||
* Set the PromiseResult of promise.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
static inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_promise_set_result (ecma_object_t *obj_p, /**< points to promise object */
|
||||
@@ -97,6 +99,8 @@ ecma_promise_get_flags (ecma_object_t *obj_p) /**< points to promise object */
|
||||
|
||||
/**
|
||||
* Set the PromiseState of promise.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
static inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_promise_set_state (ecma_object_t *obj_p, /**< points to promise object */
|
||||
|
||||
@@ -18,8 +18,6 @@
|
||||
|
||||
#include "ecma-globals.h"
|
||||
|
||||
#if JERRY_BUILTIN_SHAREDARRAYBUFFER
|
||||
|
||||
/** \addtogroup ecma ECMA
|
||||
* @{
|
||||
*
|
||||
@@ -27,6 +25,8 @@
|
||||
* @{
|
||||
*/
|
||||
|
||||
#if JERRY_BUILTIN_SHAREDARRAYBUFFER
|
||||
|
||||
ecma_value_t ecma_op_create_shared_arraybuffer_object (const ecma_value_t *, uint32_t);
|
||||
|
||||
/**
|
||||
|
||||
@@ -98,8 +98,6 @@ ecma_op_create_string_object (const ecma_value_t *arguments_list_p, /**< list of
|
||||
|
||||
/**
|
||||
* List names of a String object's lazy instantiated properties
|
||||
*
|
||||
* @return string values collection
|
||||
*/
|
||||
void
|
||||
ecma_op_string_list_lazy_property_names (ecma_object_t *obj_p, /**< a String object */
|
||||
|
||||
Reference in new issue
Block a user