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ó [email protected]

Author: LaszloLango

Doxyfile

@@ -341,7 +341,7 @@ IDL_PROPERTY_SUPPORT   = YES
 # all members of a group must be documented explicitly.
 # The default value is: NO.
 
-DISTRIBUTE_GROUP_DOC   = NO
+DISTRIBUTE_GROUP_DOC   = YES
 
 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
 # (for instance a group of public functions) to be put as a subgroup of that
@@ -409,7 +409,7 @@ LOOKUP_CACHE_SIZE      = 0
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = YES
+EXTRACT_ALL            = NO
 
 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
 # be included in the documentation.
@@ -1960,15 +1960,15 @@ ENABLE_PREPROCESSING   = YES
 # The default value is: NO.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-MACRO_EXPANSION        = NO
+MACRO_EXPANSION        = YES
 
 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
 # the macro expansion is limited to the macros specified with the PREDEFINED and
 # EXPAND_AS_DEFINED tags.
 # The default value is: NO.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-EXPAND_ONLY_PREDEF     = NO
+EXPAND_ONLY_PREDEF     = YES
 
 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
 # INCLUDE_PATH will be searched if a #include is found.
@@ -2000,7 +2000,7 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             =
+PREDEFINED             = JERRY_STATIC_ASSERT(x,y)=
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

jerry-core/api/jerry.c

@@ -869,7 +869,8 @@ jerry_value_get_type (const jerry_value_t value) /**< input value to check */
  * @return true  - if the specified feature is enabled,
  *         false - otherwise
  */
-bool jerry_is_feature_enabled (const jerry_feature_t feature)
+bool
+jerry_is_feature_enabled (const jerry_feature_t feature) /**< feature to check */
 {
   JERRY_ASSERT (feature < JERRY_FEATURE__COUNT);
 
@@ -929,7 +930,7 @@ bool jerry_is_feature_enabled (const jerry_feature_t feature)
  * Clear the error flag
  */
 void
-jerry_value_clear_error_flag (jerry_value_t *value_p)
+jerry_value_clear_error_flag (jerry_value_t *value_p) /**< api value */
 {
   jerry_assert_api_available ();
 
@@ -943,7 +944,7 @@ jerry_value_clear_error_flag (jerry_value_t *value_p)
  * Set the error flag if the value is not an error reference.
  */
 void
-jerry_value_set_error_flag (jerry_value_t *value_p)
+jerry_value_set_error_flag (jerry_value_t *value_p) /**< api value */
 {
   jerry_assert_api_available ();
 
@@ -966,7 +967,7 @@ jerry_value_set_error_flag (jerry_value_t *value_p)
  * Set both the abort and error flags if the value is not an error reference.
  */
 void
-jerry_value_set_abort_flag (jerry_value_t *value_p)
+jerry_value_set_abort_flag (jerry_value_t *value_p) /**< api value */
 {
   jerry_assert_api_available ();
 
@@ -1505,7 +1506,7 @@ jerry_create_string_sz (const jerry_char_t *str_p, /**< pointer to string */
  * @return length of the given array
  */
 uint32_t
-jerry_get_array_length (const jerry_value_t value)
+jerry_get_array_length (const jerry_value_t value) /**< api value */
 {
   jerry_assert_api_available ();
 
@@ -1557,7 +1558,7 @@ jerry_get_string_size (const jerry_value_t value) /**< input string */
  * @return number of bytes in the buffer needed to represent the UTF-8 encoded string
  */
 jerry_size_t
-jerry_get_utf8_string_size (const jerry_value_t value)
+jerry_get_utf8_string_size (const jerry_value_t value) /**< input string */
 {
   jerry_assert_api_available ();
 
@@ -2494,8 +2495,9 @@ jerry_set_object_native_handle (const jerry_value_t obj_val, /**< object to set
  * @return true - traversal was interrupted by the callback.
  *         false - otherwise - traversal visited all objects.
  */
-bool jerry_objects_foreach (jerry_objects_foreach_t foreach_p,
-                            void *user_data_p)
+bool
+jerry_objects_foreach (jerry_objects_foreach_t foreach_p, /**< function pointer of the iterator function */
+                       void *user_data_p) /**< pointer to user data */
 {
   jerry_assert_api_available ();
 
@@ -2522,9 +2524,11 @@ bool jerry_objects_foreach (jerry_objects_foreach_t foreach_p,
  *         false - otherwise - traversal visited all objects.
  */
 bool
-jerry_objects_foreach_by_native_info (const jerry_object_native_info_t *native_info_p,
-                                      jerry_objects_foreach_by_native_info_t foreach_p,
-                                      void *user_data_p)
+jerry_objects_foreach_by_native_info (const jerry_object_native_info_t *native_info_p, /**< the type info
+                                                                                        *   of the native pointer */
+                                      jerry_objects_foreach_by_native_info_t foreach_p, /**< function to apply for
+                                                                                         *   each matching object */
+                                      void *user_data_p) /**< pointer to user data */
 {
   jerry_assert_api_available ();
 
@@ -2757,7 +2761,7 @@ jerry_is_valid_cesu8_string (const jerry_char_t *cesu8_buf_p, /**< CESU-8 string
                                     (lit_utf8_size_t) buf_size);
 } /* jerry_is_valid_cesu8_string */
 
-/*
+/**
  * Create a jerry instance for external context.
  *
  * @return the pointer to the instance.
@@ -2866,7 +2870,7 @@ jerry_set_vm_exec_stop_callback (jerry_vm_exec_stop_callback_t stop_cb, /**< per
  * @return array value
  */
 jerry_value_t
-jerry_get_backtrace (uint32_t max_depth)
+jerry_get_backtrace (uint32_t max_depth) /**< depth limit of the backtrace */
 {
   return vm_get_backtrace (max_depth);
 } /* jerry_get_backtrace */
@@ -3143,14 +3147,20 @@ jerry_value_is_typedarray (jerry_value_t value) /**< value to check if it is a T
 } /* jerry_value_is_typedarray */
 
 #ifndef CONFIG_DISABLE_ES2015_TYPEDARRAY_BUILTIN
+/**
+ * TypedArray mapping type
+ */
 typedef struct
 {
-  jerry_typedarray_type_t api_type;
-  ecma_builtin_id_t prototype_id;
-  lit_magic_string_id_t lit_id;
-  uint8_t element_size_shift;
+  jerry_typedarray_type_t api_type; /**< api type */
+  ecma_builtin_id_t prototype_id; /**< prototype ID */
+  lit_magic_string_id_t lit_id; /**< literal ID */
+  uint8_t element_size_shift; /**< element size shift */
 } jerry_typedarray_mapping_t;
 
+/**
+ * List of TypedArray mappings
+ */
 static jerry_typedarray_mapping_t jerry_typedarray_mappings[] =
 {
 #define TYPEDARRAY_ENTRY(NAME, LIT_NAME, SIZE_SHIFT) \

jerry-core/ecma/base/ecma-gc.c

@@ -55,6 +55,9 @@
 
 /**
  * Get next object in list of objects with same generation.
+ *
+ * @return pointer to the next ecma-object
+ *         NULL - if there is no next ecma-object
  */
 static inline ecma_object_t *
 ecma_gc_get_object_next (ecma_object_t *object_p) /**< object */
@@ -78,6 +81,9 @@ ecma_gc_set_object_next (ecma_object_t *object_p, /**< object */
 
 /**
  * Get visited flag of the object.
+ *
+ * @return true  - if visited
+ *         false - otherwise
  */
 static inline bool
 ecma_gc_is_object_visited (ecma_object_t *object_p) /**< object */

jerry-core/ecma/base/ecma-helpers-conversion.c

@@ -322,20 +322,29 @@
   ECMA_NUMBER_CONVERSION_128BIT_INTEGER_CHECK_PARTS_ARE_32BIT (name); \
 }
 
+/**
+ * Value of epsilon
+ */
 #define EPSILON 0.0000001
 
 #if CONFIG_ECMA_NUMBER_TYPE == CONFIG_ECMA_NUMBER_FLOAT64
 /**
- * Number.MAX_VALUE and Number.MIN_VALUE exponent parts while using 64 bit float representation
+ * Number.MAX_VALUE exponent part when using 64 bit float representation.
  */
-# define NUMBER_MAX_DECIMAL_EXPONENT 308
-# define NUMBER_MIN_DECIMAL_EXPONENT -324
+#define NUMBER_MAX_DECIMAL_EXPONENT 308
+/**
+ * Number.MIN_VALUE exponent part when using 64 bit float representation.
+ */
+#define NUMBER_MIN_DECIMAL_EXPONENT -324
 #elif CONFIG_ECMA_NUMBER_TYPE == CONFIG_ECMA_NUMBER_FLOAT32
 /**
- * Number.MAX_VALUE and Number.MIN_VALUE exponent parts while using 32 bit float representation
+ * Number.MAX_VALUE exponent part when using 32 bit float representation.
  */
-# define NUMBER_MAX_DECIMAL_EXPONENT 38
-# define NUMBER_MIN_DECIMAL_EXPONENT -45
+#define NUMBER_MAX_DECIMAL_EXPONENT 38
+/**
+ * Number.MIN_VALUE exponent part when using 32 bit float representation.
+ */
+#define NUMBER_MIN_DECIMAL_EXPONENT -45
 #endif /* CONFIG_ECMA_NUMBER_TYPE == CONFIG_ECMA_NUMBER_FLOAT64 */
 
 /**
@@ -934,13 +943,15 @@ ecma_number_to_int32 (ecma_number_t num) /**< ecma-number */
 } /* ecma_number_to_int32 */
 
 /**
-  * Perform conversion of ecma-number to decimal representation with decimal exponent
+  * Perform conversion of ecma-number to decimal representation with decimal exponent.
   *
   * Note:
   *      The calculated values correspond to s, n, k parameters in ECMA-262 v5, 9.8.1, item 5:
   *         - parameter out_digits_p corresponds to s, the digits of the number;
   *         - parameter out_decimal_exp_p corresponds to n, the decimal exponent;
   *         - return value corresponds to k, the number of digits.
+  *
+  * @return the number of digits
   */
 lit_utf8_size_t
 ecma_number_to_decimal (ecma_number_t num, /**< ecma-number */
@@ -1068,14 +1079,16 @@ ecma_double_to_binary_floating_point (double val, /**< ecma number */
 } /* ecma_double_to_binary_floating_point */
 
 /**
-  * Perform conversion of ecma-number to equivalent binary floating-point number representation with decimal exponent
-  *
-  * Note:
-  *      The calculated values correspond to s, n, k parameters in ECMA-262 v5, 9.8.1, item 5:
-  *         - parameter out_digits_p corresponds to s, the digits of the number;
-  *         - parameter out_decimal_exp_p corresponds to n, the decimal exponent;
-  *         - return value corresponds to k, the number of digits.
-  */
+ * Perform conversion of ecma-number to equivalent binary floating-point number representation with decimal exponent.
+ *
+ * Note:
+ *      The calculated values correspond to s, n, k parameters in ECMA-262 v5, 9.8.1, item 5:
+ *         - parameter out_digits_p corresponds to s, the digits of the number;
+ *         - parameter out_decimal_exp_p corresponds to n, the decimal exponent;
+ *         - return value corresponds to k, the number of digits.
+ *
+ * @return the number of digits
+ */
 lit_utf8_size_t
 ecma_number_to_binary_floating_point_number (ecma_number_t num, /**< ecma-number */
                                              lit_utf8_byte_t *out_digits_p, /**< [out] buffer to fill with digits */

jerry-core/ecma/base/ecma-helpers-errol.c

@@ -54,11 +54,17 @@
  */
 
 /**
- * Floating point format definitions
+ * Floating point format definitions (next float value)
  */
 #define ECMA_NEXT_FLOAT(value) (nextafter ((value), INFINITY))
+/**
+ * Floating point format definitions (previous float value)
+ */
 #define ECMA_PREV_FLOAT(value) (nextafter ((value), -INFINITY))
 
+/**
+ * Value of epsilon
+ */
 #define ERROL0_EPSILON 0.0000001
 
 /**

jerry-core/ecma/base/ecma-helpers-number.c

@@ -31,7 +31,9 @@ JERRY_STATIC_ASSERT (ECMA_DIRECT_SHIFT == ECMA_VALUE_SHIFT + 1,
 
 JERRY_STATIC_ASSERT (((1 << (ECMA_DIRECT_SHIFT - 1)) | ECMA_TYPE_DIRECT) == ECMA_DIRECT_TYPE_SIMPLE_VALUE,
                      currently_directly_encoded_values_start_after_direct_type_simple_value);
-
+/**
+ * Position of the sign bit in ecma-numbers
+ */
 #define ECMA_NUMBER_SIGN_POS (ECMA_NUMBER_FRACTION_WIDTH + \
                               ECMA_NUMBER_BIASED_EXP_WIDTH)
 

jerry-core/ecma/base/ecma-helpers-string.c

@@ -410,7 +410,7 @@ ecma_new_ecma_string_from_uint32 (uint32_t uint32_number) /**< uint32 value of t
  * @return pointer to ecma-string descriptor
  */
 ecma_string_t *
-ecma_get_ecma_string_from_uint32 (uint32_t uint32_number)
+ecma_get_ecma_string_from_uint32 (uint32_t uint32_number) /**< input number */
 {
   JERRY_ASSERT (uint32_number <= ECMA_DIRECT_STRING_MAX_IMM);
 
@@ -839,8 +839,8 @@ ecma_concat_ecma_strings (ecma_string_t *string1_p, /**< first ecma-string */
  * @return concatenation of an ecma-string and a magic string
  */
 ecma_string_t *
-ecma_append_magic_string_to_string (ecma_string_t *string1_p,
-                                    lit_magic_string_id_t string2_id)
+ecma_append_magic_string_to_string (ecma_string_t *string1_p, /**< string descriptor */
+                                    lit_magic_string_id_t string2_id) /**< magic string ID */
 {
   if (JERRY_UNLIKELY (ecma_string_is_empty (string1_p)))
   {
@@ -953,6 +953,8 @@ ecma_deref_ecma_string (ecma_string_t *string_p) /**< ecma-string */
 
 /**
  * Convert ecma-string to number
+ *
+ * @return converted ecma-number
  */
 ecma_number_t
 ecma_string_to_number (const ecma_string_t *string_p) /**< ecma-string */
@@ -1560,7 +1562,11 @@ ecma_string_is_length (const ecma_string_t *string_p) /**< property name */
   return ecma_compare_ecma_string_to_magic_id (string_p, LIT_MAGIC_STRING_LENGTH);
 } /* ecma_string_is_length */
 
-
+/**
+ * Converts a property name into a string
+ *
+ * @return pointer to the converted ecma string
+ */
 static inline ecma_string_t * JERRY_ATTR_ALWAYS_INLINE
 ecma_property_to_string (ecma_property_t property, /**< property name type */
                          jmem_cpointer_t prop_name_cp) /**< property name compressed pointer */
@@ -1914,7 +1920,7 @@ ecma_compare_ecma_strings_relational (const ecma_string_t *string1_p, /**< ecma-
                                               utf8_string2_size);
 } /* ecma_compare_ecma_strings_relational */
 
-/*
+/**
  * Special value to represent that no size is available.
  */
 #define ECMA_STRING_NO_ASCII_SIZE 0xffff