Fix FILE_PATTERNS of Doxyfile and some of the issues it was hiding (#2446)
`FILE_PATTERNS` is a space-separated list, in contrary to what is suggested by its documentation. The pattern `*.h, *.c` does not match header files but files with `.h,` extension only. Rewriting the current comma-separated pattern makes Doxygen actually process header files. However, it also reveals several hitherto hidden issues (mostly missing documentation) in the code. This patch fixes some of these documentation problems (and lists the files with outstanding issues in a 'backlog'). JerryScript-DCO-1.0-Signed-off-by: Akos Kiss akiss@inf.u-szeged.hu
This commit is contained in:
@@ -56,6 +56,7 @@ typedef ecma_value_t (*ecma_builtin_dispatch_call_t)(const ecma_value_t argument
|
||||
*/
|
||||
static const ecma_builtin_dispatch_routine_t ecma_builtin_routines[] =
|
||||
{
|
||||
/** @cond doxygen_suppress */
|
||||
#define BUILTIN(a, b, c, d, e)
|
||||
#define BUILTIN_ROUTINE(builtin_id, \
|
||||
object_type, \
|
||||
@@ -76,6 +77,7 @@ static const ecma_builtin_dispatch_routine_t ecma_builtin_routines[] =
|
||||
#include "ecma-builtins.inc.h"
|
||||
#undef BUILTIN
|
||||
#undef BUILTIN_ROUTINE
|
||||
/** @endcond */
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -83,6 +85,7 @@ static const ecma_builtin_dispatch_routine_t ecma_builtin_routines[] =
|
||||
*/
|
||||
static const ecma_builtin_dispatch_call_t ecma_builtin_call_functions[] =
|
||||
{
|
||||
/** @cond doxygen_suppress */
|
||||
#define BUILTIN(a, b, c, d, e)
|
||||
#define BUILTIN_ROUTINE(builtin_id, \
|
||||
object_type, \
|
||||
@@ -93,6 +96,7 @@ static const ecma_builtin_dispatch_call_t ecma_builtin_call_functions[] =
|
||||
#include "ecma-builtins.inc.h"
|
||||
#undef BUILTIN_ROUTINE
|
||||
#undef BUILTIN
|
||||
/** @endcond */
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -100,6 +104,7 @@ static const ecma_builtin_dispatch_call_t ecma_builtin_call_functions[] =
|
||||
*/
|
||||
static const ecma_builtin_dispatch_call_t ecma_builtin_construct_functions[] =
|
||||
{
|
||||
/** @cond doxygen_suppress */
|
||||
#define BUILTIN(a, b, c, d, e)
|
||||
#define BUILTIN_ROUTINE(builtin_id, \
|
||||
object_type, \
|
||||
@@ -110,6 +115,7 @@ static const ecma_builtin_dispatch_call_t ecma_builtin_construct_functions[] =
|
||||
#include "ecma-builtins.inc.h"
|
||||
#undef BUILTIN_ROUTINE
|
||||
#undef BUILTIN
|
||||
/** @endcond */
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -117,6 +123,7 @@ static const ecma_builtin_dispatch_call_t ecma_builtin_construct_functions[] =
|
||||
*/
|
||||
static const ecma_builtin_property_list_reference_t ecma_builtin_property_list_references[] =
|
||||
{
|
||||
/** @cond doxygen_suppress */
|
||||
#define BUILTIN(a, b, c, d, e)
|
||||
#define BUILTIN_ROUTINE(builtin_id, \
|
||||
object_type, \
|
||||
@@ -137,6 +144,7 @@ static const ecma_builtin_property_list_reference_t ecma_builtin_property_list_r
|
||||
#include "ecma-builtins.inc.h"
|
||||
#undef BUILTIN_ROUTINE
|
||||
#undef BUILTIN
|
||||
/** @endcond */
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -435,6 +443,7 @@ ecma_instantiate_builtin (ecma_builtin_id_t id) /**< built-in id */
|
||||
JERRY_ASSERT (id < ECMA_BUILTIN_ID__COUNT);
|
||||
switch (id)
|
||||
{
|
||||
/** @cond doxygen_suppress */
|
||||
#define BUILTIN(builtin_id, \
|
||||
object_type, \
|
||||
object_prototype_builtin_id, \
|
||||
@@ -452,6 +461,7 @@ ecma_instantiate_builtin (ecma_builtin_id_t id) /**< built-in id */
|
||||
#include "ecma-builtins.inc.h"
|
||||
#undef BUILTIN
|
||||
#undef BUILTIN_ROUTINE
|
||||
/** @endcond */
|
||||
default:
|
||||
{
|
||||
JERRY_UNREACHABLE (); /* The built-in is not implemented. */
|
||||
|
||||
@@ -23,6 +23,7 @@
|
||||
*/
|
||||
typedef enum
|
||||
{
|
||||
/** @cond doxygen_suppress */
|
||||
#define BUILTIN(a, b, c, d, e)
|
||||
#define BUILTIN_ROUTINE(builtin_id, \
|
||||
object_type, \
|
||||
@@ -43,6 +44,7 @@ typedef enum
|
||||
#include "ecma-builtins.inc.h"
|
||||
#undef BUILTIN
|
||||
#undef BUILTIN_ROUTINE
|
||||
/** @endcond */
|
||||
ECMA_BUILTIN_ID__COUNT /**< number of built-in objects */
|
||||
} ecma_builtin_id_t;
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
/** \addtogroup ecma ECMA
|
||||
* @{
|
||||
*
|
||||
* \addtogroup ecmabuiltinhelpers ECMA TypedArray helper operations
|
||||
* \addtogroup ecmabuiltinhelpers ECMA builtin helper operations
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user