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

Doc comment maintenance

Browse Source 
Fixed doc comments issues:

* Fixed mistyped param doc comments (`/**<` is OK, `/** <` is not).

* Put special characters (e.g., pipe, backslash, etc.) in quotes, as they can
  confuse doxygen and it will print lots of various warnings. For the sake of
  completeness and consistent style, also quote some special characters in
  re-bytecode.h

* Added missing `@{`s, removed extra `@}`s.

* Turned `/*` comments to `/**<` doc comments.

Ensured same style for doc groups everywhere:

* Where `\addtogroup`, `@{`, and `@}` doxygen commands are used, the order to be
  followed is: license, `#ifndef` guards (in headers), includes, `\addtogroup`
  and `@{`, main code content, `@}`, `#endif` guards (in headers).

* Multiple `\addtogroup`s or multiple `@}`s should be in the same doc comment.

* First `\addtogroup` should be on the very first line of a doc comment, i.e.,
  `/** \addtogroup`.

JerryScript-DCO-1.0-Signed-off-by: Akos Kiss akiss@inf.u-szeged.hu
This commit is contained in:
Akos Kiss
2016-04-09 21:27:43 +02:00
parent a7f015ef47
commit 9aca0086b9
34 changed files with 177 additions and 214 deletions
Download Patch File Download Diff File Expand all files Collapse all files
jerry-core/parser/regexp/re-bytecode.h
+3 -3
View File
@@ -75,9 +75,9 @@ typedef enum
RE_OP_ASSERT_NOT_WORD_BOUNDARY, /**< "\B" */
RE_OP_LOOKAHEAD_POS, /**< lookahead pos */
RE_OP_LOOKAHEAD_NEG, /**< lookahead neg */
RE_OP_BACKREFERENCE, /**< \[0..9] */
RE_OP_CHAR_CLASS, /**< [ ] */
RE_OP_INV_CHAR_CLASS /**< [^ ] */
RE_OP_BACKREFERENCE, /**< "\[0..9]" */
RE_OP_CHAR_CLASS, /**< "[ ]" */
RE_OP_INV_CHAR_CLASS /**< "[^ ]" */
} re_opcode_t;
/**
jerry-core/parser/regexp/re-parser.h
+20 -20
View File
@@ -35,27 +35,27 @@
typedef enum
{
RE_TOK_EOF, /**< EOF */
RE_TOK_BACKREFERENCE, /**< \[0..9] */
RE_TOK_BACKREFERENCE, /**< "\[0..9]" */
RE_TOK_CHAR, /**< any character */
RE_TOK_ALTERNATIVE, /**< | */
RE_TOK_ASSERT_START, /**< ^ */
RE_TOK_ASSERT_END, /**< $ */
RE_TOK_PERIOD, /**< . */
RE_TOK_START_CAPTURE_GROUP, /**< ( */
RE_TOK_START_NON_CAPTURE_GROUP, /**< (?: */
RE_TOK_END_GROUP, /**< ')' */
RE_TOK_ASSERT_START_POS_LOOKAHEAD, /**< (?= */
RE_TOK_ASSERT_START_NEG_LOOKAHEAD, /**< (?! */
RE_TOK_ASSERT_WORD_BOUNDARY, /**< \b */
RE_TOK_ASSERT_NOT_WORD_BOUNDARY, /**< \B */
RE_TOK_DIGIT, /**< \d */
RE_TOK_NOT_DIGIT, /**< \D */
RE_TOK_WHITE, /**< \s */
RE_TOK_NOT_WHITE, /**< \S */
RE_TOK_WORD_CHAR, /**< \w */
RE_TOK_NOT_WORD_CHAR, /**< \W */
RE_TOK_START_CHAR_CLASS, /**< [ ] */
RE_TOK_START_INV_CHAR_CLASS, /**< [^ ] */
RE_TOK_ALTERNATIVE, /**< "|" */
RE_TOK_ASSERT_START, /**< "^" */
RE_TOK_ASSERT_END, /**< "$" */
RE_TOK_PERIOD, /**< "." */
RE_TOK_START_CAPTURE_GROUP, /**< "(" */
RE_TOK_START_NON_CAPTURE_GROUP, /**< "(?:" */
RE_TOK_END_GROUP, /**< ")" */
RE_TOK_ASSERT_START_POS_LOOKAHEAD, /**< "(?=" */
RE_TOK_ASSERT_START_NEG_LOOKAHEAD, /**< "(?!" */
RE_TOK_ASSERT_WORD_BOUNDARY, /**< "\b" */
RE_TOK_ASSERT_NOT_WORD_BOUNDARY, /**< "\B" */
RE_TOK_DIGIT, /**< "\d" */
RE_TOK_NOT_DIGIT, /**< "\D" */
RE_TOK_WHITE, /**< "\s" */
RE_TOK_NOT_WHITE, /**< "\S" */
RE_TOK_WORD_CHAR, /**< "\w" */
RE_TOK_NOT_WORD_CHAR, /**< "\W" */
RE_TOK_START_CHAR_CLASS, /**< "[ ]" */
RE_TOK_START_INV_CHAR_CLASS, /**< "[^ ]" */
} re_token_type_t;
/**