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/ecma/builtin-objects/ecma-builtin-array-prototype.c
+4 -4
View File
@@ -295,7 +295,7 @@ ecma_builtin_array_prototype_object_concat (ecma_value_t this_arg, /**< this arg
* Returned value must be freed with ecma_free_completion_value.
*/
static ecma_completion_value_t
ecma_op_array_get_separator_string (ecma_value_t separator) /** < possible separator */
ecma_op_array_get_separator_string (ecma_value_t separator) /**< possible separator */
{
if (ecma_is_value_undefined (separator))
{
@@ -318,8 +318,8 @@ ecma_op_array_get_separator_string (ecma_value_t separator) /** < possible separ
* Returned value must be freed with ecma_free_completion_value.
*/
static ecma_completion_value_t
ecma_op_array_get_to_string_at_index (ecma_object_t *obj_p, /** < this object */
uint32_t index) /** < array index */
ecma_op_array_get_to_string_at_index (ecma_object_t *obj_p, /**< this object */
uint32_t index) /**< array index */
{
ecma_completion_value_t ret_value = ecma_make_empty_completion_value ();
ecma_string_t *index_string_p = ecma_new_ecma_string_from_uint32 (index);
@@ -357,7 +357,7 @@ ecma_op_array_get_to_string_at_index (ecma_object_t *obj_p, /** < this object */
*/
static ecma_completion_value_t
ecma_builtin_array_prototype_join (const ecma_value_t this_arg, /**< this argument */
const ecma_value_t separator_arg) /** < separator argument */
const ecma_value_t separator_arg) /**< separator argument */
{
ecma_completion_value_t ret_value = ecma_make_empty_completion_value ();
jerry-core/ecma/builtin-objects/ecma-builtin-function.c
+2 -2
View File
@@ -65,8 +65,8 @@ ecma_builtin_function_dispatch_call (const ecma_value_t *arguments_list_p, /**<
* Returned value must be freed with ecma_free_completion_value.
*/
static ecma_completion_value_t
ecma_builtin_function_helper_get_function_expression (const ecma_value_t *arguments_list_p, /** < arguments list */
ecma_length_t arguments_list_len) /** < number of arguments */
ecma_builtin_function_helper_get_function_expression (const ecma_value_t *arguments_list_p, /**< arguments list */
ecma_length_t arguments_list_len) /**< number of arguments */
{
JERRY_ASSERT (arguments_list_len == 0 || arguments_list_p != NULL);
jerry-core/ecma/builtin-objects/ecma-builtin-global.c
+2 -2
View File
@@ -53,8 +53,8 @@
*
* The routine converts all of its arguments to strings and outputs them using 'printf'.
*
* Code points, with except of <NUL> character, that are representable with one utf8-byte
* are outputted as is, using '%c' format argument, and other code points are outputted as '\uhhll',
* Code points, with except of NUL character, that are representable with one utf8-byte
* are outputted as is, using "%c" format argument, and other code points are outputted as "\uhhll",
* where hh and ll are values of code point's high and low bytes, correspondingly.
*
* @return completion value
jerry-core/ecma/builtin-objects/ecma-builtin-helpers.c
+5 -5
View File
@@ -124,8 +124,8 @@ ecma_builtin_helper_object_to_string (const ecma_value_t this_arg) /**< this arg
* Returned value must be freed with ecma_free_completion_value.
*/
ecma_completion_value_t
ecma_builtin_helper_get_to_locale_string_at_index (ecma_object_t *obj_p, /** < this object */
uint32_t index) /** < array index */
ecma_builtin_helper_get_to_locale_string_at_index (ecma_object_t *obj_p, /**< this object */
uint32_t index) /**< array index */
{
ecma_completion_value_t ret_value = ecma_make_empty_completion_value ();
ecma_string_t *index_string_p = ecma_new_ecma_string_from_uint32 (index);
@@ -196,8 +196,8 @@ ecma_builtin_helper_get_to_locale_string_at_index (ecma_object_t *obj_p, /** < t
* Returned value must be freed with ecma_free_completion_value.
*/
ecma_completion_value_t
ecma_builtin_helper_object_get_properties (ecma_object_t *obj_p, /** < object */
bool only_enumerable_properties) /** < list enumerable properties? */
ecma_builtin_helper_object_get_properties (ecma_object_t *obj_p, /**< object */
bool only_enumerable_properties) /**< list enumerable properties? */
{
JERRY_ASSERT (obj_p != NULL);
@@ -564,7 +564,7 @@ ecma_builtin_helper_string_find_index (ecma_string_t *original_str_p, /**< index
ecma_string_t *search_str_p, /**< string's length */
bool first_index, /**< whether search for first (t) or last (f) index */
ecma_length_t start_pos, /**< start position */
ecma_length_t *ret_index_p) /**> position found in original string */
ecma_length_t *ret_index_p) /**< position found in original string */
{
bool match_found = false;
jerry-core/ecma/builtin-objects/ecma-builtin-json.c
+1 -1
View File
@@ -608,7 +608,7 @@ ecma_builtin_json_parse_value (ecma_json_token_t *token_p) /**< token argument *
static ecma_completion_value_t
ecma_builtin_json_walk (ecma_object_t *reviver_p, /**< reviver function */
ecma_object_t *holder_p, /**< holder object */
ecma_string_t *name_p) /** < property name */
ecma_string_t *name_p) /**< property name */
{
JERRY_ASSERT (reviver_p);
JERRY_ASSERT (holder_p);
jerry-core/ecma/builtin-objects/ecma-builtin-regexp-prototype.c
+1 -1
View File
@@ -41,7 +41,7 @@
* \addtogroup ecmabuiltins
* @{
*
* \addtogroup regexp ECMA RegExp.prototype object built-in
* \addtogroup regexpprototype ECMA RegExp.prototype object built-in
* @{
*/