YourWishes/jerryscript
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix FILE_PATTERNS of Doxyfile and some of the issues it was hiding (#2446)

Browse Source 
`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:
Akos Kiss
2018-08-13 05:42:19 +02:00
committed by yichoi
parent 29e7330b9b
commit 79d1a3cc7e
12 changed files with 182 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files
jerry-core/parser/js/common.h
+8 -8
View File
@@ -57,21 +57,21 @@ typedef enum
/* Flags for status_flags. */
/* Local identifier (var, function arg). */
/** Local identifier (var, function arg). */
#define LEXER_FLAG_VAR 0x01
/* This local identifier cannot be stored in register. */
/** This local identifier cannot be stored in register. */
#define LEXER_FLAG_NO_REG_STORE 0x02
/* This local identifier is initialized with a value. */
/** This local identifier is initialized with a value. */
#define LEXER_FLAG_INITIALIZED 0x04
/* This local identifier has a reference to the function itself. */
/** This local identifier has a reference to the function itself. */
#define LEXER_FLAG_FUNCTION_NAME 0x08
/* This local identifier is a function argument. */
/** This local identifier is a function argument. */
#define LEXER_FLAG_FUNCTION_ARGUMENT 0x10
/* This local identifier is not used in the current context. */
/** This local identifier is not used in the current context. */
#define LEXER_FLAG_UNUSED_IDENT 0x20
/* No space is allocated for this character literal. */
/** No space is allocated for this character literal. */
#define LEXER_FLAG_SOURCE_PTR 0x40
/* Initialize this variable after the byte code is freed. */
/** Initialize this variable after the byte code is freed. */
#define LEXER_FLAG_LATE_INIT 0x80
/**
jerry-core/parser/js/js-parser-limits.h
+28 -14
View File
@@ -26,46 +26,60 @@
* @{
*/
/* Maximum identifier length accepted by the parser.
* Limit: LEXER_MAX_STRING_LENGTH. */
/**
* Maximum identifier length accepted by the parser.
* Limit: LEXER_MAX_STRING_LENGTH.
*/
#ifndef PARSER_MAXIMUM_IDENT_LENGTH
#define PARSER_MAXIMUM_IDENT_LENGTH 255
#endif /* !PARSER_MAXIMUM_IDENT_LENGTH */
/* Maximum string limit.
* Limit: 2147483647 / 65535. */
/**
* Maximum string limit.
* Limit: 2147483647 / 65535.
*/
#ifdef JERRY_CPOINTER_32_BIT
#define PARSER_MAXIMUM_STRING_LIMIT 2147483647
#else /* !JERRY_CPOINTER_32_BIT */
#define PARSER_MAXIMUM_STRING_LIMIT 65535
#endif /* JERRY_CPOINTER_32_BIT */
/* Maximum string length.
* Limit: PARSER_MAXIMUM_STRING_LIMIT. */
/**
* Maximum string length.
* Limit: PARSER_MAXIMUM_STRING_LIMIT.
*/
#ifndef PARSER_MAXIMUM_STRING_LENGTH
#define PARSER_MAXIMUM_STRING_LENGTH PARSER_MAXIMUM_STRING_LIMIT
#endif /* !PARSER_MAXIMUM_STRING_LENGTH */
/* Maximum number of literals.
* Limit: 32767. Recommended: 510, 32767 */
/**
* Maximum number of literals.
* Limit: 32767. Recommended: 510, 32767
*/
#ifndef PARSER_MAXIMUM_NUMBER_OF_LITERALS
#define PARSER_MAXIMUM_NUMBER_OF_LITERALS 32767
#endif /* !PARSER_MAXIMUM_NUMBER_OF_LITERALS */
/* Maximum number of registers.
* Limit: PARSER_MAXIMUM_NUMBER_OF_LITERALS */
/**
* Maximum number of registers.
* Limit: PARSER_MAXIMUM_NUMBER_OF_LITERALS
*/
#ifndef PARSER_MAXIMUM_NUMBER_OF_REGISTERS
#define PARSER_MAXIMUM_NUMBER_OF_REGISTERS 256
#endif /* !PARSER_MAXIMUM_NUMBER_OF_REGISTERS */
/* Maximum code size.
* Limit: 16777215. Recommended: 65535, 16777215. */
/**
* Maximum code size.
* Limit: 16777215. Recommended: 65535, 16777215.
*/
#ifndef PARSER_MAXIMUM_CODE_SIZE
#define PARSER_MAXIMUM_CODE_SIZE (65535 << (JMEM_ALIGNMENT_LOG))
#endif /* !PARSER_MAXIMUM_CODE_SIZE */
/* Maximum number of values pushed onto the stack by a function.
* Limit: 65500. Recommended: 1024. */
/**
 * Maximum number of values pushed onto the stack by a function.
* Limit: 65500. Recommended: 1024.
*/
#ifndef PARSER_MAXIMUM_STACK_LIMIT
#define PARSER_MAXIMUM_STACK_LIMIT 1024
jerry-core/parser/js/js-parser.h
+3 -1
View File
@@ -122,7 +122,9 @@ typedef enum
PARSER_ERR_NON_STRICT_ARG_DEFINITION /**< non-strict argument definition */
} parser_error_t;
/* Source code line counter type. */
/**
* Source code line counter type.
*/
typedef uint32_t parser_line_counter_t;
/**