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

Eliminating doxygen warnings by fixing the documentation

Browse Source 
* Fix "end of file while inside a group" doxygen warnings.

* Fix "unknown command" doxygen warnings caused by incorrect
  argument references. Instead of `@foo`, `@a foo` is the proper
  format.

* Fix "unknown command" doxygen warnings caused by incorrect
  parameter direction specifications. Instead of `@in`, `@out`,
  and `@in-out`, `[in]`, `[out]`, and `[in,out]` are the proper
  formats.

* Wrapping special characters in quotes to avoid doxygen
  confusion. Raw pipe, semicolon, dot, backslash, etc. characters
  can drive doxygen into various misinterpretations and warnings.
  E.g.:
  ```
  End of list marker found without any preceding list items
  Found unknown command
  ```
  Putting quotes around such text snipets eliminates the errors.

* Fix the documentation of `ecma_builtin_global_object_print`. Raw
  <> and \ sequences confused doxygen in various ways (it tried to
  interpret them as XML tags and doxygen commands).

* Fix "ignoring title that does not match old title" doxygen
  warnings. At some places, the group titles were out of sync, at
  others, the group names were incorrect.

* Fix "parameters are not documented" doxygen warnings. Fixing
  various typos in the inline parameter documentations (`/*`,
  `/**`, `/** <`, and `/**>` are all considered incorrect, the
  right format is `/**<`).

JerryScript-DCO-1.0-Signed-off-by: Akos Kiss akiss@inf.u-szeged.hu
This commit is contained in:
Akos Kiss
2016-02-16 18:11:33 +01:00
parent ed12df5c8d
commit 0d7ea70b41
25 changed files with 113 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files
jerry-core/parser/js/common.h
+6
View File
@@ -164,4 +164,10 @@ void util_print_literal (lexer_literal_t *);
#define PARSER_INLINE inline
#define PARSER_NOINLINE __attribute__ ((noinline))
/**
* @}
* @}
* @}
*/
#endif /* !COMMON_H */
jerry-core/parser/js/js-lexer.h
+50 -50
View File
@@ -49,15 +49,15 @@ typedef enum
#define LEXER_IS_UNARY_LVALUE_OP_TOKEN(token_type) \
((token_type) >= LEXER_KEYW_DELETE && (token_type) <= LEXER_DECREASE)
LEXER_PLUS, /**< + */
LEXER_NEGATE, /**< - */
LEXER_LOGICAL_NOT, /**< ! */
LEXER_BIT_NOT, /**< ~ */
LEXER_PLUS, /**< "+" */
LEXER_NEGATE, /**< "-" */
LEXER_LOGICAL_NOT, /**< "!" */
LEXER_BIT_NOT, /**< "~" */
LEXER_KEYW_VOID, /**< void */
LEXER_KEYW_TYPEOF, /**< typeof */
LEXER_KEYW_DELETE, /**< delete */
LEXER_INCREASE, /**< ++ */
LEXER_DECREASE, /**< -- */
LEXER_INCREASE, /**< "++" */
LEXER_DECREASE, /**< "--" */
/* Binary operators
* IMPORTANT: update CBC_BINARY_OP_TOKEN_TO_OPCODE,
@@ -69,53 +69,53 @@ typedef enum
((token_type) >= LEXER_ASSIGN && (token_type) <= LEXER_ASSIGN_BIT_XOR)
#define LEXER_FIRST_BINARY_OP LEXER_ASSIGN
LEXER_ASSIGN, /**< = (prec: 3) */
LEXER_ASSIGN_ADD, /**< += (prec: 3) */
LEXER_ASSIGN_SUBTRACT, /**< -= (prec: 3) */
LEXER_ASSIGN_MULTIPLY, /**< *= (prec: 3) */
LEXER_ASSIGN_DIVIDE, /**< /= (prec: 3) */
LEXER_ASSIGN_MODULO, /**< %= (prec: 3) */
LEXER_ASSIGN_LEFT_SHIFT, /**< <<= (prec: 3) */
LEXER_ASSIGN_RIGHT_SHIFT, /**< >>= (prec: 3) */
LEXER_ASSIGN_UNS_RIGHT_SHIFT, /**< >>>= (prec: 3) */
LEXER_ASSIGN_BIT_AND, /**< &= (prec: 3) */
LEXER_ASSIGN_BIT_OR, /**< |= (prec: 3) */
LEXER_ASSIGN_BIT_XOR, /**< ^= (prec: 3) */
LEXER_QUESTION_MARK, /**< ? (prec: 4) */
LEXER_LOGICAL_OR, /**< || (prec: 5) */
LEXER_LOGICAL_AND, /**< && (prec: 6) */
LEXER_BIT_OR, /**< | (prec: 7) */
LEXER_BIT_XOR, /**< ^ (prec: 8) */
LEXER_BIT_AND, /**< & (prec: 9) */
LEXER_EQUAL, /**< == (prec: 10) */
LEXER_NOT_EQUAL, /**< != (prec: 10) */
LEXER_STRICT_EQUAL, /**< === (prec: 10) */
LEXER_STRICT_NOT_EQUAL, /**< !== (prec: 10) */
LEXER_LESS, /**< < (prec: 11) */
LEXER_GREATER, /**< > (prec: 11) */
LEXER_LESS_EQUAL, /**< <= (prec: 11) */
LEXER_GREATER_EQUAL, /**< >= (prec: 11) */
LEXER_ASSIGN, /**< "=" (prec: 3) */
LEXER_ASSIGN_ADD, /**< "+=" (prec: 3) */
LEXER_ASSIGN_SUBTRACT, /**< "-=" (prec: 3) */
LEXER_ASSIGN_MULTIPLY, /**< "*=" (prec: 3) */
LEXER_ASSIGN_DIVIDE, /**< "/=" (prec: 3) */
LEXER_ASSIGN_MODULO, /**< "%=" (prec: 3) */
LEXER_ASSIGN_LEFT_SHIFT, /**< "<<=" (prec: 3) */
LEXER_ASSIGN_RIGHT_SHIFT, /**< ">>=" (prec: 3) */
LEXER_ASSIGN_UNS_RIGHT_SHIFT, /**< ">>>=" (prec: 3) */
LEXER_ASSIGN_BIT_AND, /**< "&=" (prec: 3) */
LEXER_ASSIGN_BIT_OR, /**< "|=" (prec: 3) */
LEXER_ASSIGN_BIT_XOR, /**< "^=" (prec: 3) */
LEXER_QUESTION_MARK, /**< "?" (prec: 4) */
LEXER_LOGICAL_OR, /**< "||" (prec: 5) */
LEXER_LOGICAL_AND, /**< "&&" (prec: 6) */
LEXER_BIT_OR, /**< "|" (prec: 7) */
LEXER_BIT_XOR, /**< "^" (prec: 8) */
LEXER_BIT_AND, /**< "&" (prec: 9) */
LEXER_EQUAL, /**< "==" (prec: 10) */
LEXER_NOT_EQUAL, /**< "!=" (prec: 10) */
LEXER_STRICT_EQUAL, /**< "===" (prec: 10) */
LEXER_STRICT_NOT_EQUAL, /**< "!==" (prec: 10) */
LEXER_LESS, /**< "<" (prec: 11) */
LEXER_GREATER, /**< ">" (prec: 11) */
LEXER_LESS_EQUAL, /**< "<=" (prec: 11) */
LEXER_GREATER_EQUAL, /**< ">=" (prec: 11) */
LEXER_KEYW_IN, /**< in (prec: 11) */
LEXER_KEYW_INSTANCEOF, /**< instanceof (prec: 11) */
LEXER_LEFT_SHIFT, /**< << (prec: 12) */
LEXER_RIGHT_SHIFT, /**< >> (prec: 12) */
LEXER_UNS_RIGHT_SHIFT, /**< >>> (prec: 12) */
LEXER_ADD, /**< + (prec: 13) */
LEXER_SUBTRACT, /**< - (prec: 13) */
LEXER_MULTIPLY, /**< * (prec: 14) */
LEXER_DIVIDE, /**< / (prec: 14) */
LEXER_MODULO, /**< % (prec: 14) */
LEXER_LEFT_SHIFT, /**< "<<" (prec: 12) */
LEXER_RIGHT_SHIFT, /**< ">>" (prec: 12) */
LEXER_UNS_RIGHT_SHIFT, /**< ">>>" (prec: 12) */
LEXER_ADD, /**< "+" (prec: 13) */
LEXER_SUBTRACT, /**< "-" (prec: 13) */
LEXER_MULTIPLY, /**< "*" (prec: 14) */
LEXER_DIVIDE, /**< "/" (prec: 14) */
LEXER_MODULO, /**< "%" (prec: 14) */
LEXER_LEFT_BRACE, /**< { */
LEXER_LEFT_PAREN, /**< ( */
LEXER_LEFT_SQUARE, /**< [ */
LEXER_RIGHT_BRACE, /**< } */
LEXER_RIGHT_PAREN, /**<_) */
LEXER_RIGHT_SQUARE, /**< ] */
LEXER_DOT, /**< . */
LEXER_SEMICOLON, /**< ; */
LEXER_COLON, /**< : */
LEXER_COMMA, /**< , */
LEXER_LEFT_BRACE, /**< "{" */
LEXER_LEFT_PAREN, /**< "(" */
LEXER_LEFT_SQUARE, /**< "[" */
LEXER_RIGHT_BRACE, /**< "}" */
LEXER_RIGHT_PAREN, /**<_")" */
LEXER_RIGHT_SQUARE, /**< "]" */
LEXER_DOT, /**< "." */
LEXER_SEMICOLON, /**< ";" */
LEXER_COLON, /**< ":" */
LEXER_COMMA, /**< "," */
LEXER_KEYW_BREAK, /**< break */
LEXER_KEYW_DO, /**< do */
jerry-core/parser/js/js-parser-mem.c
+8 -8
View File
@@ -471,8 +471,8 @@ parser_stack_pop_uint16 (parser_context_t *context_p) /**< context */
*/
void
parser_stack_push (parser_context_t *context_p, /**< context */
const void *data_p, /* data pushed onto the stack */
uint32_t length) /* length of the data */
const void *data_p, /**< data pushed onto the stack */
uint32_t length) /**< length of the data */
{
uint32_t fragment_length = PARSER_STACK_PAGE_SIZE - context_p->stack.last_position;
const uint8_t *bytes_p = (const uint8_t *) data_p;
@@ -529,8 +529,8 @@ parser_stack_push (parser_context_t *context_p, /**< context */
*/
void
parser_stack_pop (parser_context_t *context_p, /**< context */
void *data_p, /* destination buffer, can be NULL */
uint32_t length) /* length of the data */
void *data_p, /**< destination buffer, can be NULL */
uint32_t length) /**< length of the data */
{
uint8_t *bytes_p = (uint8_t *) data_p;
parser_mem_page_t *page_p = context_p->stack.first_p;
@@ -604,8 +604,8 @@ parser_stack_iterator_skip (parser_stack_iterator_t *iterator, /**< iterator */
*/
void
parser_stack_iterator_read (parser_stack_iterator_t *iterator, /**< iterator */
void *data_p, /* destination buffer */
size_t length) /* length of the data */
void *data_p, /**< destination buffer */
size_t length) /**< length of the data */
{
uint8_t *bytes_p = (uint8_t *) data_p;
@@ -636,8 +636,8 @@ parser_stack_iterator_read (parser_stack_iterator_t *iterator, /**< iterator */
*/
void
parser_stack_iterator_write (parser_stack_iterator_t *iterator, /**< iterator */
const void *data_p, /* destination buffer */
size_t length) /* length of the data */
const void *data_p, /**< destination buffer */
size_t length) /**< length of the data */
{
const uint8_t *bytes_p = (const uint8_t *) data_p;
jerry-core/parser/regexp/re-compiler.c
+1
View File
@@ -920,6 +920,7 @@ re_dump_bytecode (re_bytecode_ctx_t *bc_ctx_p) /**< RegExp bytecode context */
#endif /* JERRY_ENABLE_LOG */
/**
* @}
* @}
* @}
*/
jerry-core/parser/regexp/re-compiler.h
+6 -6
View File
@@ -56,14 +56,14 @@ typedef enum
RE_OP_CHAR, /**< any character */
RE_OP_SAVE_AT_START, /**< save at start */
RE_OP_SAVE_AND_MATCH, /**< save and match */
RE_OP_PERIOD, /**< . */
RE_OP_ALTERNATIVE, /**< | */
RE_OP_PERIOD, /**< "." */
RE_OP_ALTERNATIVE, /**< "|" */
RE_OP_GREEDY_ITERATOR, /**< greedy iterator */
RE_OP_NON_GREEDY_ITERATOR, /**< non-greedy iterator */
RE_OP_ASSERT_START, /**< ^ */
RE_OP_ASSERT_END, /**< $ */
RE_OP_ASSERT_WORD_BOUNDARY, /**< \b */
RE_OP_ASSERT_NOT_WORD_BOUNDARY, /**< \B */
RE_OP_ASSERT_START, /**< "^" */
RE_OP_ASSERT_END, /**< "$" */
RE_OP_ASSERT_WORD_BOUNDARY, /**< "\b" */
RE_OP_ASSERT_NOT_WORD_BOUNDARY, /**< "\B" */
RE_OP_LOOKAHEAD_POS, /**< lookahead pos */
RE_OP_LOOKAHEAD_NEG, /**< lookahead neg */
RE_OP_BACKREFERENCE, /**< \[0..9] */
jerry-core/parser/regexp/re-parser.h
+1
View File
@@ -113,6 +113,7 @@ ecma_completion_value_t
re_parse_next_token (re_parser_ctx_t *, re_token_t *);
/**
* @}
* @}
* @}
*/