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/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;