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:
Máté Tokodi
2023-11-15 09:49:04 +01:00
committed by GitHub
parent bc408b159b
commit ff9ff8f36c
31 changed files with 512 additions and 208 deletions
+2 -2
View File
@@ -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 */
+10 -10
View File
@@ -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.
*
+1 -2
View File
@@ -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);
+1 -1
View File
@@ -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. */