Update Doxygen config file and fix Doxygen warnings (#2324)

A lot of warnings remained hibben because 'EXTRACT_ALL' was previously set to YES.

JerryScript-DCO-1.0-Signed-off-by: László Langó llango.u-szeged@partner.samsung.com
This commit is contained in:
László Langó
2018-05-18 08:43:17 +02:00
committed by yichoi
parent fb6259b2ec
commit 64b16bf190
28 changed files with 315 additions and 88 deletions
+2 -1
View File
@@ -305,7 +305,8 @@ ecma_op_to_number (ecma_value_t value) /**< ecma value */
* Returned value must be freed with ecma_free_value
*/
ecma_value_t
ecma_get_number (ecma_value_t value, ecma_number_t *number_p)
ecma_get_number (ecma_value_t value, /**< ecma value*/
ecma_number_t *number_p) /**< [out] ecma number */
{
if (ecma_is_value_integer_number (value))
{
+9 -2
View File
@@ -34,12 +34,19 @@
* \addtogroup exceptions Exceptions
* @{
*/
/**
* Map error type to error prototype.
*/
typedef struct
{
ecma_standard_error_t error_type;
ecma_builtin_id_t error_prototype_id;
ecma_standard_error_t error_type; /**< Native error type */
ecma_builtin_id_t error_prototype_id; /**< ID of the error prototype */
} ecma_error_mapping_t;
/**
* List of error type mappings
*/
const ecma_error_mapping_t ecma_error_mappings[] =
{
#define ERROR_ELEMENT(TYPE, ID) { TYPE, ID }
@@ -41,7 +41,7 @@
* false - otherwise
*/
inline bool JERRY_ATTR_ALWAYS_INLINE
ecma_is_normal_or_arrow_function (ecma_object_type_t type)
ecma_is_normal_or_arrow_function (ecma_object_type_t type) /**< object type */
{
#ifndef CONFIG_DISABLE_ES2015_ARROW_FUNCTION
return (type == ECMA_OBJECT_TYPE_FUNCTION || type == ECMA_OBJECT_TYPE_ARROW_FUNCTION);
+1 -1
View File
@@ -46,7 +46,7 @@ typedef struct
{
ecma_value_t promise; /**< promise to be resolved */
ecma_value_t thenable; /**< thenbale object */
ecma_value_t then; /** 'then' function */
ecma_value_t then; /**< 'then' function */
} ecma_job_promise_resolve_thenable_t;
/**
@@ -1281,6 +1281,9 @@ ecma_op_object_get_own_property_descriptor (ecma_object_t *object_p, /**< the ob
*
* See also:
* ECMA-262 v5, 8.6.2; ECMA-262 v5, Table 9
*
* @return ecma value containing a boolean value or an error
* Returned value must be freed with ecma_free_value
*/
ecma_value_t
ecma_op_object_has_instance (ecma_object_t *obj_p, /**< the object */
@@ -1729,6 +1732,9 @@ ecma_op_object_get_property_names (ecma_object_t *obj_p, /**< object */
/**
* The function is used in the assert of ecma_object_get_class_name
*
* @return true - if class name is an object
* false - otherwise
*/
inline static bool
ecma_object_check_class_name_is_object (ecma_object_t *obj_p) /**< object */
@@ -52,6 +52,10 @@
* [n+1] n/2 th group end
*/
#define RE_GLOBAL_START_IDX 0
/**
* @copydoc RE_GLOBAL_START_IDX
*/
#define RE_GLOBAL_END_IDX 1
/**