diff options
| author | Akos Kiss <akiss@inf.u-szeged.hu> | 2018-08-13 05:42:19 +0200 |
|---|---|---|
| committer | yichoi <duddlf.choi@samsung.com> | 2018-08-13 12:42:19 +0900 |
| commit | 79d1a3cc7ed8e7551a9d444b2d2fad4c4b11b239 (patch) | |
| tree | 08287fc1f3f67c2e92f4572359ce5e0917f356cd /jerry-core/lit | |
| parent | 29e7330b9b9ea062ed32dab70a79f293f6e1a05b (diff) | |
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
Diffstat (limited to 'jerry-core/lit')
| -rw-r--r-- | jerry-core/lit/lit-magic-strings.c | 6 | ||||
| -rw-r--r-- | jerry-core/lit/lit-magic-strings.h | 2 |
2 files changed, 8 insertions, 0 deletions
diff --git a/jerry-core/lit/lit-magic-strings.c b/jerry-core/lit/lit-magic-strings.c index 08cd5a41..183e400c 100644 --- a/jerry-core/lit/lit-magic-strings.c +++ b/jerry-core/lit/lit-magic-strings.c @@ -39,12 +39,14 @@ lit_get_magic_string_utf8 (lit_magic_string_id_t id) /**< magic string id */ { static const lit_utf8_byte_t * const lit_magic_strings[] JERRY_CONST_DATA = { +/** @cond doxygen_suppress */ #define LIT_MAGIC_STRING_FIRST_STRING_WITH_SIZE(size, id) #define LIT_MAGIC_STRING_DEF(id, utf8_string) \ (const lit_utf8_byte_t *) utf8_string, #include "lit-magic-strings.inc.h" #undef LIT_MAGIC_STRING_DEF #undef LIT_MAGIC_STRING_FIRST_STRING_WITH_SIZE +/** @endcond */ }; JERRY_ASSERT (id < LIT_NON_INTERNAL_MAGIC_STRING__COUNT); @@ -62,12 +64,14 @@ lit_get_magic_string_size (lit_magic_string_id_t id) /**< magic string id */ { static const lit_magic_size_t lit_magic_string_sizes[] JERRY_CONST_DATA = { +/** @cond doxygen_suppress */ #define LIT_MAGIC_STRING_FIRST_STRING_WITH_SIZE(size, id) #define LIT_MAGIC_STRING_DEF(id, utf8_string) \ sizeof(utf8_string) - 1, #include "lit-magic-strings.inc.h" #undef LIT_MAGIC_STRING_DEF #undef LIT_MAGIC_STRING_FIRST_STRING_WITH_SIZE +/** @endcond */ }; JERRY_ASSERT (id < LIT_NON_INTERNAL_MAGIC_STRING__COUNT); @@ -86,6 +90,7 @@ lit_get_magic_string_size_block_start (lit_utf8_size_t size) /**< magic string s { static const lit_magic_string_id_t lit_magic_string_size_block_starts[] JERRY_CONST_DATA = { +/** @cond doxygen_suppress */ #define LIT_MAGIC_STRING_DEF(id, utf8_string) #define LIT_MAGIC_STRING_FIRST_STRING_WITH_SIZE(size, id) \ id, @@ -93,6 +98,7 @@ lit_get_magic_string_size_block_start (lit_utf8_size_t size) /**< magic string s LIT_NON_INTERNAL_MAGIC_STRING__COUNT #undef LIT_MAGIC_STRING_DEF #undef LIT_MAGIC_STRING_FIRST_STRING_WITH_SIZE +/** @endcond */ }; JERRY_ASSERT (size <= (sizeof (lit_magic_string_size_block_starts) / sizeof (lit_magic_string_id_t))); diff --git a/jerry-core/lit/lit-magic-strings.h b/jerry-core/lit/lit-magic-strings.h index 8f31b974..8d470e8d 100644 --- a/jerry-core/lit/lit-magic-strings.h +++ b/jerry-core/lit/lit-magic-strings.h @@ -23,12 +23,14 @@ */ typedef enum { +/** @cond doxygen_suppress */ #define LIT_MAGIC_STRING_FIRST_STRING_WITH_SIZE(size, id) #define LIT_MAGIC_STRING_DEF(id, ascii_zt_string) \ id, #include "lit-magic-strings.inc.h" #undef LIT_MAGIC_STRING_DEF #undef LIT_MAGIC_STRING_FIRST_STRING_WITH_SIZE +/** @endcond */ LIT_NON_INTERNAL_MAGIC_STRING__COUNT, /**< number of non-internal magic strings */ LIT_INTERNAL_MAGIC_STRING_PROMISE = LIT_NON_INTERNAL_MAGIC_STRING__COUNT, /**< [[Promise]] of promise * reject or resolve functions */ |