Fix doxygen-related documentation issues (#1357)

JerryScript-DCO-1.0-Signed-off-by: Akos Kiss akiss@inf.u-szeged.hu
This commit is contained in:
Akos Kiss
2016-09-21 10:43:40 +02:00
committed by GitHub
parent 2300a68c88
commit 316223ebdb
9 changed files with 74 additions and 18 deletions
@@ -29,7 +29,7 @@
/** \addtogroup ecma ECMA
* @{
*
* \addtogroup ecmabuiltinhelpers
* \addtogroup ecmabuiltinhelpers ECMA builtin helper operations
* @{
*/
@@ -22,7 +22,7 @@
/** \addtogroup ecma ECMA
* @{
*
* \addtogroup ecmahelpers Helpers for operations with ECMA data types
* \addtogroup ecmabuiltinhelpers ECMA builtin helper operations
* @{
*/
@@ -31,7 +31,7 @@
/** \addtogroup ecma ECMA
* @{
*
* \addtogroup ecmaoperations ECMA-defined operations
* \addtogroup lexicalenvironment Lexical environment
* @{
*/
@@ -27,7 +27,7 @@
/** \addtogroup ecma ECMA
* @{
*
* \addtogroup ecmageneralobjectsinternalops General ECMA objects' operations
* \addtogroup ecmaobjectsinternalops ECMA objects' operations
* @{
*/
+1 -1
View File
@@ -43,7 +43,7 @@
/**
* Assert that specified object type value is valid
*
* @param object's implementation-defined type
* @param type object's implementation-defined type
*/
#ifndef JERRY_NDEBUG
#define JERRY_ASSERT_OBJECT_TYPE_IS_VALID(type) \
+1 -5
View File
@@ -16,10 +16,7 @@
#include "jcontext.h"
/** \addtogroup context Jerry context
* @{
*
* \addtogroup context Context
/** \addtogroup context Context
* @{
*/
@@ -52,6 +49,5 @@ jerry_hash_table_t jerry_global_hash_table;
#endif /* !CONFIG_ECMA_LCACHE_DISABLE */
/**
* @}
* @}
*/
+1 -5
View File
@@ -26,10 +26,7 @@
#include "re-bytecode.h"
#include "vm-defines.h"
/** \addtogroup context Jerry context
* @{
*
* \addtogroup context Context
/** \addtogroup context Context
* @{
*/
@@ -167,7 +164,6 @@ extern jerry_hash_table_t jerry_global_hash_table;
#endif /* !CONFIG_ECMA_LCACHE_DISABLE */
/**
* @}
* @}
*/
+1 -1
View File
@@ -65,7 +65,7 @@ static const char * const wrong_args_msg_p = "wrong type of argument";
#endif /* JERRY_ENABLE_ERROR_MESSAGES */
/** \addtogroup jerry_extension Jerry engine extension interface
/** \addtogroup jerry Jerry engine interface
* @{
*/
+66 -2
View File
@@ -273,6 +273,18 @@ typedef struct
#endif /* PARSER_DUMP_BYTE_CODE */
} parser_context_t;
/**
* @}
* @}
* @}
*
* \addtogroup mem Memory allocation
* @{
*
* \addtogroup mem_parser Parser memory manager
* @{
*/
/* Memory management.
* Note: throws an error if unsuccessful. */
void *parser_malloc (parser_context_t *, size_t);
@@ -311,6 +323,20 @@ void parser_stack_iterator_skip (parser_stack_iterator_t *, size_t);
void parser_stack_iterator_read (parser_stack_iterator_t *, void *, size_t);
void parser_stack_iterator_write (parser_stack_iterator_t *, const void *, size_t);
/**
* @}
* @}
*
* \addtogroup parser Parser
* @{
*
* \addtogroup jsparser JavaScript
* @{
*
* \addtogroup jsparser_utils Utility
* @{
*/
/* Compact byte code emitting functions. */
void parser_flush_cbc (parser_context_t *);
@@ -338,6 +364,13 @@ void parser_set_continues_to_current_position (parser_context_t *, parser_branch
#define parser_emit_cbc_ext_backward_branch(context_p, opcode, offset) \
parser_emit_cbc_backward_branch ((context_p), PARSER_TO_EXT_OPCODE (opcode), (offset))
/**
* @}
*
* \addtogroup jsparser_lexer Lexer
* @{
*/
/* Lexer functions */
void lexer_next_token (parser_context_t *);
@@ -351,14 +384,45 @@ void lexer_construct_function_object (parser_context_t *, uint32_t);
void lexer_construct_regexp_object (parser_context_t *, bool);
bool lexer_compare_identifier_to_current (parser_context_t *, const lexer_lit_location_t *);
/**
* @}
*
* \addtogroup jsparser_expr Expression parser
* @{
*/
/* Parser functions. */
void parser_parse_expression (parser_context_t *, int);
void parser_parse_statements (parser_context_t *);
/**
* @}
*
* \addtogroup jsparser_scanner Scanner
* @{
*/
void parser_scan_until (parser_context_t *, lexer_range_t *, lexer_token_type_t);
ecma_compiled_code_t *parser_parse_function (parser_context_t *, uint32_t);
/**
* @}
*
* \addtogroup jsparser_stmt Statement parser
* @{
*/
void parser_parse_statements (parser_context_t *);
void parser_free_jumps (parser_stack_iterator_t);
/**
* @}
*
* \addtogroup jsparser_parser Parser
* @{
*/
ecma_compiled_code_t *parser_parse_function (parser_context_t *, uint32_t);
/* Error management. */
void parser_raise_error (parser_context_t *, parser_error_t);