Eliminating doxygen warnings by fixing the documentation
* 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:
@@ -328,7 +328,7 @@ lit_char_hex_to_int (ecma_char_t c) /**< code unit, corresponding to
|
||||
bool
|
||||
lit_read_code_point_from_hex (lit_utf8_byte_t *buf_p, /**< buffer with characters */
|
||||
lit_utf8_size_t number_of_characters, /**< number of characters to be read */
|
||||
lit_code_point_t *out_code_point_p) /**< @out: decoded result */
|
||||
lit_code_point_t *out_code_point_p) /**< [out] decoded result */
|
||||
{
|
||||
lit_code_point_t code_point = 0;
|
||||
|
||||
|
||||
@@ -82,7 +82,7 @@ lit_storage_create_magic_literal_ex (rcs_record_set_t *rec_set_p, /**< recordset
|
||||
* @return pointer to the created record
|
||||
*/
|
||||
rcs_record_t *
|
||||
lit_storage_create_number_literal (rcs_record_set_t *rec_set_p, /** recordset */
|
||||
lit_storage_create_number_literal (rcs_record_set_t *rec_set_p, /**< recordset */
|
||||
ecma_number_t num) /**< numeric value */
|
||||
{
|
||||
const size_t record_size = RCS_NUMBER_HEADER_SIZE + sizeof (ecma_number_t);
|
||||
|
||||
@@ -346,7 +346,7 @@ convert_code_point_to_high_surrogate (lit_code_point_t code_point) /**< code poi
|
||||
* @return next code unit
|
||||
*/
|
||||
ecma_char_t
|
||||
lit_utf8_iterator_peek_next (const lit_utf8_iterator_t *iter_p) /**< @in: utf-8 string iterator */
|
||||
lit_utf8_iterator_peek_next (const lit_utf8_iterator_t *iter_p) /**< [in] utf-8 string iterator */
|
||||
{
|
||||
JERRY_ASSERT (!lit_utf8_iterator_is_eos (iter_p));
|
||||
|
||||
@@ -377,7 +377,7 @@ lit_utf8_iterator_peek_next (const lit_utf8_iterator_t *iter_p) /**< @in: utf-8
|
||||
* Increment iterator to point to next code unit
|
||||
*/
|
||||
void
|
||||
lit_utf8_iterator_incr (lit_utf8_iterator_t *iter_p) /**< @in-out: utf-8 string iterator */
|
||||
lit_utf8_iterator_incr (lit_utf8_iterator_t *iter_p) /**< [in,out] utf-8 string iterator */
|
||||
{
|
||||
lit_utf8_iterator_read_next (iter_p);
|
||||
} /* lit_utf8_iterator_incr */
|
||||
@@ -386,7 +386,7 @@ lit_utf8_iterator_incr (lit_utf8_iterator_t *iter_p) /**< @in-out: utf-8 string
|
||||
* Skip specified number of code units
|
||||
*/
|
||||
void
|
||||
lit_utf8_iterator_advance (lit_utf8_iterator_t *iter_p, /**< in-out: iterator */
|
||||
lit_utf8_iterator_advance (lit_utf8_iterator_t *iter_p, /**< [in,out] iterator */
|
||||
ecma_length_t chars_count) /**< number of code units to skip */
|
||||
{
|
||||
while (chars_count--)
|
||||
@@ -401,7 +401,7 @@ lit_utf8_iterator_advance (lit_utf8_iterator_t *iter_p, /**< in-out: iterator */
|
||||
* @return next code unit
|
||||
*/
|
||||
ecma_char_t
|
||||
lit_utf8_iterator_read_next (lit_utf8_iterator_t *iter_p) /**< @in-out: utf-8 string iterator */
|
||||
lit_utf8_iterator_read_next (lit_utf8_iterator_t *iter_p) /**< [in,out] utf-8 string iterator */
|
||||
{
|
||||
JERRY_ASSERT (!lit_utf8_iterator_is_eos (iter_p));
|
||||
|
||||
@@ -491,7 +491,7 @@ lit_utf8_string_length (const lit_utf8_byte_t *utf8_buf_p, /**< utf-8 string */
|
||||
lit_utf8_size_t
|
||||
lit_read_code_point_from_utf8 (const lit_utf8_byte_t *buf_p, /**< buffer with characters */
|
||||
lit_utf8_size_t buf_size, /**< size of the buffer in bytes */
|
||||
lit_code_point_t *code_point) /**< @out: code point */
|
||||
lit_code_point_t *code_point) /**< [out] code point */
|
||||
{
|
||||
JERRY_ASSERT (buf_p && buf_size);
|
||||
|
||||
@@ -543,7 +543,7 @@ lit_read_code_point_from_utf8 (const lit_utf8_byte_t *buf_p, /**< buffer with ch
|
||||
*/
|
||||
lit_utf8_size_t
|
||||
lit_read_code_unit_from_utf8 (const lit_utf8_byte_t *buf_p, /**< buffer with characters */
|
||||
ecma_char_t *code_point) /**< @out: code point */
|
||||
ecma_char_t *code_point) /**< [out] code point */
|
||||
{
|
||||
JERRY_ASSERT (buf_p);
|
||||
|
||||
@@ -586,7 +586,7 @@ lit_read_code_unit_from_utf8 (const lit_utf8_byte_t *buf_p, /**< buffer with cha
|
||||
*/
|
||||
lit_utf8_size_t
|
||||
lit_read_prev_code_unit_from_utf8 (const lit_utf8_byte_t *buf_p, /**< buffer with characters */
|
||||
ecma_char_t *code_point) /**< @out: code point */
|
||||
ecma_char_t *code_point) /**< [out] code point */
|
||||
{
|
||||
JERRY_ASSERT (buf_p);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user