mirror of
https://github.com/jerryscript-project/jerryscript.git
synced 2025-12-15 16:29:21 +00:00
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
This commit is contained in:
parent
bc408b159b
commit
ff9ff8f36c
8
.github/workflows/gh-actions.yml
vendored
8
.github/workflows/gh-actions.yml
vendored
@ -17,12 +17,12 @@ jobs:
|
||||
python-version: '3.10'
|
||||
- run: sudo apt update
|
||||
# TODO: update checkers to current versions available in ubuntu 22.04
|
||||
# - run: sudo apt install doxygen clang-format-10 cppcheck python-serial
|
||||
- run: sudo apt install pylint
|
||||
# - run: sudo apt install clang-format-10 cppcheck python-serial
|
||||
- run: sudo apt install pylint doxygen
|
||||
- run: $RUNNER --check-signed-off=gh-actions
|
||||
if: ${{ always() }}
|
||||
# - run: $RUNNER --check-doxygen
|
||||
# if: ${{ always() }}
|
||||
- run: $RUNNER --check-doxygen
|
||||
if: ${{ always() }}
|
||||
# - run: $RUNNER --check-format
|
||||
# if: ${{ always() }}
|
||||
- run: $RUNNER --check-license
|
||||
|
||||
@ -31,6 +31,10 @@
|
||||
#include "lit-char-helpers.h"
|
||||
#include "re-compiler.h"
|
||||
|
||||
/** \addtogroup jerrysnapshot Jerry snapshot operations
|
||||
* @{
|
||||
*/
|
||||
|
||||
#if JERRY_SNAPSHOT_SAVE || JERRY_SNAPSHOT_EXEC
|
||||
|
||||
/**
|
||||
@ -88,9 +92,6 @@ typedef struct
|
||||
bool class_found;
|
||||
} snapshot_globals_t;
|
||||
|
||||
/** \addtogroup jerrysnapshot Jerry snapshot operations
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* Write data into the specified buffer.
|
||||
@ -1045,10 +1046,6 @@ jerry_exec_snapshot (const uint32_t *snapshot_p, /**< snapshot */
|
||||
#endif /* JERRY_SNAPSHOT_EXEC */
|
||||
} /* jerry_exec_snapshot */
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
#if JERRY_SNAPSHOT_SAVE
|
||||
|
||||
/**
|
||||
@ -1716,3 +1713,7 @@ jerry_get_literals_from_snapshot (const uint32_t *snapshot_p, /**< input snapsho
|
||||
return 0;
|
||||
#endif /* JERRY_SNAPSHOT_SAVE */
|
||||
} /* jerry_get_literals_from_snapshot */
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
@ -115,6 +115,8 @@ JERRY_STATIC_ASSERT (((NUMBER_ARITHMETIC_SUBTRACTION + ECMA_NUMBER_ARITHMETIC_OP
|
||||
* The API could not be invoked in the following cases:
|
||||
* - before jerry_init and after jerry_cleanup
|
||||
* - between enter to and return from a native free callback
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
static inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
jerry_assert_api_enabled (void)
|
||||
@ -124,6 +126,8 @@ jerry_assert_api_enabled (void)
|
||||
|
||||
/**
|
||||
* Turn on API availability
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
static inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
jerry_api_enable (void)
|
||||
@ -135,6 +139,8 @@ jerry_api_enable (void)
|
||||
|
||||
/**
|
||||
* Turn off API availability
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
static inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
jerry_api_disable (void)
|
||||
|
||||
@ -61,6 +61,8 @@ ecma_alloc_number (void)
|
||||
|
||||
/**
|
||||
* Dealloc memory from an ecma-number
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_dealloc_number (ecma_number_t *number_p) /**< number to be freed */
|
||||
@ -85,6 +87,8 @@ ecma_alloc_object (void)
|
||||
|
||||
/**
|
||||
* Dealloc memory from an ecma-object
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_dealloc_object (ecma_object_t *object_p) /**< object to be freed */
|
||||
@ -113,6 +117,8 @@ ecma_alloc_extended_object (size_t size) /**< size of object */
|
||||
|
||||
/**
|
||||
* Dealloc memory of an extended object
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_dealloc_extended_object (ecma_object_t *object_p, /**< extended object */
|
||||
@ -142,6 +148,8 @@ ecma_alloc_string (void)
|
||||
|
||||
/**
|
||||
* Dealloc memory from ecma-string descriptor
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_dealloc_string (ecma_string_t *string_p) /**< string to be freed */
|
||||
@ -170,6 +178,8 @@ ecma_alloc_extended_string (void)
|
||||
|
||||
/**
|
||||
* Dealloc memory from extended ecma-string descriptor
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_dealloc_extended_string (ecma_extended_string_t *ext_string_p) /**< extended string to be freed */
|
||||
@ -198,6 +208,8 @@ ecma_alloc_external_string (void)
|
||||
|
||||
/**
|
||||
* Dealloc memory from external ecma-string descriptor
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_dealloc_external_string (ecma_external_string_t *ext_string_p) /**< external string to be freed */
|
||||
@ -226,6 +238,8 @@ ecma_alloc_string_buffer (size_t size) /**< size of string */
|
||||
|
||||
/**
|
||||
* Dealloc memory of a string with character data
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_dealloc_string_buffer (ecma_string_t *string_p, /**< string with data */
|
||||
@ -255,6 +269,8 @@ ecma_alloc_property_pair (void)
|
||||
|
||||
/**
|
||||
* Dealloc memory of an ecma-property
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_dealloc_property_pair (ecma_property_pair_t *property_pair_p) /**< property pair to be freed */
|
||||
|
||||
@ -128,6 +128,8 @@ ecma_init_gc_info (ecma_object_t *object_p) /**< object */
|
||||
|
||||
/**
|
||||
* Increase reference counter of an object
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_ref_object_inline (ecma_object_t *object_p) /**< object */
|
||||
@ -153,6 +155,8 @@ ecma_ref_object (ecma_object_t *object_p) /**< object */
|
||||
|
||||
/**
|
||||
* Decrease reference counter of an object
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_deref_object (ecma_object_t *object_p) /**< object */
|
||||
@ -466,6 +470,8 @@ ecma_gc_mark_compiled_code (ecma_value_t script_value) /**< script value */
|
||||
|
||||
/**
|
||||
* Mark objects referenced by bound function object.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
static void JERRY_ATTR_NOINLINE
|
||||
ecma_gc_mark_bound_function_object (ecma_object_t *object_p) /**< bound function object */
|
||||
|
||||
@ -49,6 +49,8 @@ ecma_new_collection (void)
|
||||
|
||||
/**
|
||||
* Deallocate a collection of ecma values without freeing it's values
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_collection_destroy (ecma_collection_t *collection_p) /**< value collection */
|
||||
|
||||
@ -78,6 +78,8 @@ typedef struct
|
||||
|
||||
/**
|
||||
* Normalize the number by factoring in the error.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
static inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_normalize_high_prec_data (ecma_high_prec_t *hp_data_p) /**< [in, out] float pair */
|
||||
@ -90,6 +92,8 @@ ecma_normalize_high_prec_data (ecma_high_prec_t *hp_data_p) /**< [in, out] float
|
||||
|
||||
/**
|
||||
* Multiply the high-precision number by ten.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
static inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_multiply_high_prec_by_10 (ecma_high_prec_t *hp_data_p) /**< [in, out] high-precision number */
|
||||
|
||||
@ -849,6 +849,8 @@ ecma_concat_ecma_strings (ecma_string_t *string1_p, /**< first ecma-string */
|
||||
|
||||
/**
|
||||
* Increase reference counter of non-direct ecma-string.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_ref_ecma_string_non_direct (ecma_string_t *string_p) /**< string descriptor */
|
||||
@ -895,6 +897,8 @@ ecma_ref_ecma_string (ecma_string_t *string_p) /**< string descriptor */
|
||||
/**
|
||||
* Decrease reference counter and deallocate a non-direct ecma-string
|
||||
* if the counter becomes zero.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_deref_ecma_string_non_direct (ecma_string_t *string_p) /**< ecma-string */
|
||||
@ -1168,6 +1172,8 @@ ecma_string_copy_to_buffer (const ecma_string_t *string_p, /**< ecma-string desc
|
||||
* Convert ecma-string's contents to a cesu-8 string and put it to the buffer.
|
||||
* It is the caller's responsibility to make sure that the string fits in the buffer.
|
||||
* Check if the size of the string is equal with the size of the buffer.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_string_to_cesu8_bytes (const ecma_string_t *string_desc_p, /**< ecma-string descriptor */
|
||||
@ -2292,6 +2298,8 @@ ecma_string_trim_back (const lit_utf8_byte_t *start_p, /**< current string's sta
|
||||
* Used by:
|
||||
* - ecma_string_trim
|
||||
* - ecma_utf8_string_to_number
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_string_trim_helper (const lit_utf8_byte_t **utf8_str_p, /**< [in, out] current string position */
|
||||
|
||||
@ -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 */
|
||||
|
||||
@ -917,6 +917,8 @@ ecma_assert_object_contains_the_property (const ecma_object_t *object_p, /**< ec
|
||||
*
|
||||
* Note:
|
||||
* value previously stored in the property is freed
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
ecma_named_data_property_assign_value (ecma_object_t *obj_p, /**< object */
|
||||
|
||||
@ -17,8 +17,6 @@
|
||||
|
||||
#include "ecma-helpers.h"
|
||||
|
||||
#if JERRY_LINE_INFO
|
||||
|
||||
/** \addtogroup ecma ECMA
|
||||
* @{
|
||||
*
|
||||
@ -26,6 +24,8 @@
|
||||
* @{
|
||||
*/
|
||||
|
||||
#if JERRY_LINE_INFO
|
||||
|
||||
/* The layout of the structure is defined in js-parser-line-info-create.c */
|
||||
|
||||
JERRY_STATIC_ASSERT ((ECMA_LINE_INFO_COLUMN_DEFAULT - 1) == ((ECMA_LINE_INFO_ENCODE_TWO_BYTE >> 1) - 1),
|
||||
|
||||
@ -55,9 +55,9 @@ ecma_json_has_object_in_stack (ecma_json_occurrence_stack_item_t *stack_p, /**<
|
||||
return false;
|
||||
} /* ecma_json_has_object_in_stack */
|
||||
|
||||
#endif /* JERRY_BUILTIN_JSON */
|
||||
|
||||
/**
|
||||
* @}
|
||||
* @}
|
||||
*/
|
||||
|
||||
#endif /* JERRY_BUILTIN_JSON */
|
||||
|
||||
@ -261,7 +261,8 @@ ecma_value_t ecma_builtin_helper_error_dispatch_call (jerry_error_t error_type,
|
||||
typedef ecma_value_t (*ecma_builtin_helper_sort_compare_fn_t) (ecma_value_t lhs, /**< left value */
|
||||
ecma_value_t rhs, /**< right value */
|
||||
ecma_value_t compare_func, /**< compare function */
|
||||
ecma_object_t *array_buffer_p); /**< arrayBuffer */
|
||||
ecma_object_t *array_buffer_p /**< arrayBuffer */
|
||||
);
|
||||
|
||||
ecma_value_t ecma_builtin_helper_array_merge_sort_helper (ecma_value_t *array_p,
|
||||
uint32_t length,
|
||||
|
||||
@ -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 */
|
||||
|
||||
@ -55,9 +55,8 @@ typedef enum
|
||||
*
|
||||
* A libc-based port may implement this with exit() or abort(), or both.
|
||||
*
|
||||
* Note: This function is expected to not return.
|
||||
*
|
||||
* @param code: the cause of the error.
|
||||
* @return This function is expected to not return.
|
||||
*/
|
||||
void JERRY_ATTR_NORETURN jerry_port_fatal (jerry_fatal_code_t code);
|
||||
|
||||
@ -115,8 +114,6 @@ struct jerry_context_t *jerry_port_context_get (void);
|
||||
*
|
||||
* This port function is called by jerry_cleanup when JERRY_EXTERNAL_CONTEXT is enabled.
|
||||
* Otherwise this function is not used.
|
||||
*
|
||||
* @return the pointer to the engine context.
|
||||
*/
|
||||
void jerry_port_context_free (void);
|
||||
|
||||
|
||||
@ -45,6 +45,8 @@ jcontext_has_pending_abort (void)
|
||||
|
||||
/**
|
||||
* Set the abort flag for the context.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
jcontext_set_abort_flag (bool is_abort) /**< true - if the abort flag should be set
|
||||
@ -64,6 +66,8 @@ jcontext_set_abort_flag (bool is_abort) /**< true - if the abort flag should be
|
||||
|
||||
/**
|
||||
* Set the exception flag for the context.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
jcontext_set_exception_flag (bool is_exception) /**< true - if the exception flag should be set
|
||||
@ -81,6 +85,8 @@ jcontext_set_exception_flag (bool is_exception) /**< true - if the exception fla
|
||||
|
||||
/**
|
||||
* Raise exception from the given error value.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
jcontext_raise_exception (ecma_value_t error) /**< error to raise */
|
||||
|
||||
@ -48,7 +48,14 @@
|
||||
#define JMEM_HEAP_GET_OFFSET_FROM_ADDR(p) ((uint32_t) (p))
|
||||
#define JMEM_HEAP_GET_ADDR_FROM_OFFSET(u) ((jmem_heap_free_t *) (u))
|
||||
#else /* !ECMA_VALUE_CAN_STORE_UINTPTR_VALUE_DIRECTLY */
|
||||
/**
|
||||
* Get heap offset from address
|
||||
*/
|
||||
#define JMEM_HEAP_GET_OFFSET_FROM_ADDR(p) ((uint32_t) ((uint8_t *) (p) -JERRY_HEAP_CONTEXT (area)))
|
||||
|
||||
/**
|
||||
* Get heap address from offset
|
||||
*/
|
||||
#define JMEM_HEAP_GET_ADDR_FROM_OFFSET(u) ((jmem_heap_free_t *) (JERRY_HEAP_CONTEXT (area) + (u)))
|
||||
#endif /* ECMA_VALUE_CAN_STORE_UINTPTR_VALUE_DIRECTLY */
|
||||
/**
|
||||
@ -302,6 +309,9 @@ jmem_heap_gc_and_alloc_block (const size_t size, /**< required memory size */
|
||||
|
||||
/**
|
||||
* Internal method for allocating a memory block.
|
||||
*
|
||||
* @return NULL, if the required memory size is 0 or not enough memory, or
|
||||
* pointer to the allocated memory block, if allocation is successful
|
||||
*/
|
||||
extern inline void *JERRY_ATTR_HOT JERRY_ATTR_ALWAYS_INLINE
|
||||
jmem_heap_alloc_block_internal (const size_t size) /**< required memory size */
|
||||
@ -449,10 +459,12 @@ jmem_heap_insert_block (jmem_heap_free_t *block_p, /**< block to insert */
|
||||
|
||||
/**
|
||||
* Internal method for freeing a memory block.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
void JERRY_ATTR_HOT
|
||||
jmem_heap_free_block_internal (void *ptr, /**< pointer to beginning of data space of the block */
|
||||
const size_t size) /**< size of allocated region */
|
||||
const size_t size /**< size of allocated region */)
|
||||
{
|
||||
JERRY_ASSERT (size > 0);
|
||||
JERRY_ASSERT (JERRY_CONTEXT (jmem_heap_limit) >= JERRY_CONTEXT (jmem_heap_allocated_size));
|
||||
@ -683,6 +695,8 @@ jmem_heap_realloc_block (void *ptr, /**< memory region to reallocate */
|
||||
|
||||
/**
|
||||
* Free memory block
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_HOT JERRY_ATTR_ALWAYS_INLINE
|
||||
jmem_heap_free_block (void *ptr, /**< pointer to beginning of data space of the block */
|
||||
|
||||
@ -114,6 +114,8 @@ jmem_pools_alloc (size_t size) /**< size of the chunk */
|
||||
|
||||
/**
|
||||
* Free the chunk
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_HOT JERRY_ATTR_ALWAYS_INLINE
|
||||
jmem_pools_free (void *chunk_p, /**< pointer to the chunk */
|
||||
|
||||
@ -30,8 +30,6 @@ JERRY_STATIC_ASSERT (offsetof (cbc_uint8_arguments_t, script_value) == offsetof
|
||||
JERRY_STATIC_ASSERT (CBC_END == 238, number_of_cbc_opcodes_changed);
|
||||
JERRY_STATIC_ASSERT (CBC_EXT_END == 167, number_of_cbc_ext_opcodes_changed);
|
||||
|
||||
#if JERRY_PARSER || JERRY_PARSER_DUMP_BYTE_CODE
|
||||
|
||||
/** \addtogroup parser Parser
|
||||
* @{
|
||||
*
|
||||
@ -42,6 +40,8 @@ JERRY_STATIC_ASSERT (CBC_EXT_END == 167, number_of_cbc_ext_opcodes_changed);
|
||||
* @{
|
||||
*/
|
||||
|
||||
#if JERRY_PARSER || JERRY_PARSER_DUMP_BYTE_CODE
|
||||
|
||||
/**
|
||||
* Compact bytecode definition
|
||||
*/
|
||||
|
||||
@ -17,11 +17,7 @@
|
||||
|
||||
#include "js-parser-internal.h"
|
||||
|
||||
#if JERRY_PARSER
|
||||
|
||||
#if JERRY_LINE_INFO
|
||||
|
||||
/* \addtogroup parser Parser
|
||||
/** \addtogroup parser Parser
|
||||
* @{
|
||||
*
|
||||
* \addtogroup jsparser JavaScript
|
||||
@ -31,6 +27,10 @@
|
||||
* @{
|
||||
*/
|
||||
|
||||
#if JERRY_PARSER
|
||||
|
||||
#if JERRY_LINE_INFO
|
||||
|
||||
/*
|
||||
* The line-info data structure uses two number encodings:
|
||||
*
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
|
||||
#include "js-lexer.h"
|
||||
|
||||
/* \addtogroup parser Parser
|
||||
/** \addtogroup parser Parser
|
||||
* @{
|
||||
*
|
||||
* \addtogroup jsparser JavaScript
|
||||
@ -135,7 +135,7 @@ parser_new_tagged_template_literal (ecma_object_t **raw_strings_p) /**< [out] ra
|
||||
* Set integrity level of the given template array object to "frozen"
|
||||
*/
|
||||
static void
|
||||
parser_tagged_template_literal_freeze_array (ecma_object_t *obj_p)
|
||||
parser_tagged_template_literal_freeze_array (ecma_object_t *obj_p /**< template object */)
|
||||
{
|
||||
JERRY_ASSERT (ecma_get_object_type (obj_p) == ECMA_OBJECT_TYPE_ARRAY);
|
||||
ecma_op_ordinary_object_prevent_extensions (obj_p);
|
||||
|
||||
@ -16,7 +16,7 @@
|
||||
#ifndef ECMA_TAGGED_TEMPLATE_LITERAL_H
|
||||
#define ECMA_TAGGED_TEMPLATE_LITERAL_H
|
||||
|
||||
/* \addtogroup parser Parser
|
||||
/** \addtogroup parser Parser
|
||||
* @{
|
||||
*
|
||||
* \addtogroup jsparser JavaScript
|
||||
@ -40,10 +40,10 @@ void parser_tagged_template_literal_append_strings (parser_context_t *context_p,
|
||||
|
||||
void parser_tagged_template_literal_finalize (ecma_object_t *template_obj_p, ecma_object_t *raw_strings_p);
|
||||
|
||||
#endif /* ECMA_TAGGED_TEMPLATE_LITERAL_H */
|
||||
|
||||
/**
|
||||
* @}
|
||||
* @}
|
||||
* @}
|
||||
*/
|
||||
|
||||
#endif /* ECMA_TAGGED_TEMPLATE_LITERAL_H */
|
||||
|
||||
@ -24,6 +24,16 @@
|
||||
#include "js-parser-internal.h"
|
||||
#include "lit-char-helpers.h"
|
||||
|
||||
/** \addtogroup parser Parser
|
||||
* @{
|
||||
*
|
||||
* \addtogroup jsparser JavaScript
|
||||
* @{
|
||||
*
|
||||
* \addtogroup jsparser_parser Parser
|
||||
* @{
|
||||
*/
|
||||
|
||||
#if JERRY_PARSER
|
||||
|
||||
JERRY_STATIC_ASSERT ((int) ECMA_PARSE_STRICT_MODE == (int) PARSER_IS_STRICT,
|
||||
@ -36,16 +46,6 @@ JERRY_STATIC_ASSERT (PARSER_RESTORE_STATUS_FLAGS (ECMA_PARSE_ALLOW_SUPER) == PAR
|
||||
JERRY_STATIC_ASSERT (PARSER_RESTORE_STATUS_FLAGS (ECMA_PARSE_FUNCTION_CONTEXT) == 0,
|
||||
ecma_parse_function_context_must_not_be_transformed);
|
||||
|
||||
/** \addtogroup parser Parser
|
||||
* @{
|
||||
*
|
||||
* \addtogroup jsparser JavaScript
|
||||
* @{
|
||||
*
|
||||
* \addtogroup jsparser_parser Parser
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* Compute real literal indicies.
|
||||
*
|
||||
|
||||
@ -16,7 +16,7 @@
|
||||
#ifndef JS_SCANNER_INTERNAL_H
|
||||
#define JS_SCANNER_INTERNAL_H
|
||||
|
||||
/* \addtogroup parser Parser
|
||||
/** \addtogroup parser Parser
|
||||
* @{
|
||||
*
|
||||
* \addtogroup jsparser JavaScript
|
||||
@ -355,7 +355,6 @@ scanner_literal_pool_t *
|
||||
scanner_push_literal_pool (parser_context_t *context_p, scanner_context_t *scanner_context_p, uint16_t status_flags);
|
||||
void scanner_pop_literal_pool (parser_context_t *context_p, scanner_context_t *scanner_context_p);
|
||||
void scanner_filter_arguments (parser_context_t *context_p, scanner_context_t *scanner_context_p);
|
||||
void scanner_construct_global_block (parser_context_t *context_p, scanner_context_t *scanner_context_p);
|
||||
lexer_lit_location_t *scanner_add_custom_literal (parser_context_t *context_p,
|
||||
scanner_literal_pool_t *literal_pool_p,
|
||||
const lexer_lit_location_t *literal_location_p);
|
||||
|
||||
@ -59,7 +59,7 @@ JERRY_STATIC_ASSERT (PARSER_SCOPE_STACK_IS_CONST_REG == PARSER_SCOPE_STACK_IS_LO
|
||||
* Raise a scanner error.
|
||||
*/
|
||||
void
|
||||
scanner_raise_error (parser_context_t *context_p) /**< context */
|
||||
scanner_raise_error (parser_context_t *context_p /**< context */)
|
||||
{
|
||||
PARSER_THROW (context_p->try_buffer);
|
||||
/* Should never been reached. */
|
||||
|
||||
@ -1181,6 +1181,8 @@ opfunc_create_implicit_class_constructor (uint8_t opcode, /**< current cbc opcod
|
||||
|
||||
/**
|
||||
* Set the [[HomeObject]] attribute of the given functon object
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
extern inline void JERRY_ATTR_ALWAYS_INLINE
|
||||
opfunc_set_home_object (ecma_object_t *func_p, /**< function object */
|
||||
@ -1636,9 +1638,6 @@ opfunc_collect_private_properties (ecma_value_t constructor, /**< constructor */
|
||||
* ClassDefinitionEvaluation environment initialization part
|
||||
*
|
||||
* See also: ECMAScript v6, 14.5.14
|
||||
*
|
||||
* @return - ECMA_VALUE_ERROR - if the operation fails
|
||||
* ECMA_VALUE_EMPTY - otherwise
|
||||
*/
|
||||
void
|
||||
opfunc_push_class_environment (vm_frame_ctx_t *frame_ctx_p, /**< frame context */
|
||||
|
||||
@ -14,7 +14,11 @@
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
doxygen 2>&1 >/dev/null | head -n 1000 | tee doxygen.log
|
||||
doxygen 2>&1 >/dev/null \
|
||||
| grep -Pv "^\/.+\.h:\d+: warning: Member .+ \(function\) of group \w+ is not documented.$" \
|
||||
| grep -Pv "^\/.+\.h:\d+: warning: documented empty return type of \w+$" \
|
||||
| grep -Pv "^\/.+\.h:\d+: warning: argument '.+' from the argument list of .+ has multiple @param documentation sections$" \
|
||||
| head -n 1000 | tee doxygen.log
|
||||
if [ -s doxygen.log ]
|
||||
then
|
||||
EXIT=1
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user