Fix documentation errors (#1510)

Doxygen reported a few issues, which are fixed by this patch:
* ArrayBuffer-related documentation group names and titles were
  incorrect.
* Some Date-related helper functions used incorrect parameter
  documentation syntax.

JerryScript-DCO-1.0-Signed-off-by: Akos Kiss akiss@inf.u-szeged.hu
This commit is contained in:
Akos Kiss
2017-01-03 18:03:47 +01:00
committed by Zoltan Herczeg
parent 3fa89baee0
commit 0026519040
4 changed files with 5 additions and 6 deletions
@@ -39,7 +39,7 @@
* \addtogroup ecmabuiltins * \addtogroup ecmabuiltins
* @{ * @{
* *
* \addtogroup arraybuffer prototype ECMA ArrayBuffer.prototype object built-in * \addtogroup arraybufferprototype ECMA ArrayBuffer.prototype object built-in
* @{ * @{
*/ */
@@ -37,7 +37,7 @@
* \addtogroup ecmabuiltins * \addtogroup ecmabuiltins
* @{ * @{
* *
* \addtogroup string ECMA ArrayBuffer object built-in * \addtogroup arraybuffer ECMA ArrayBuffer object built-in
* @{ * @{
*/ */
@@ -191,7 +191,7 @@ ecma_builtin_date_prototype_to_json (ecma_value_t this_arg) /**< this argument *
static ecma_value_t static ecma_value_t
ecma_builtin_date_prototype_dispatch_get (uint16_t builtin_routine_id, /**< built-in wide routine ecma_builtin_date_prototype_dispatch_get (uint16_t builtin_routine_id, /**< built-in wide routine
* identifier */ * identifier */
ecma_number_t date_num) /* date converted to number */ ecma_number_t date_num) /**< date converted to number */
{ {
if (ecma_number_is_nan (date_num)) if (ecma_number_is_nan (date_num))
{ {
@@ -302,7 +302,7 @@ static ecma_value_t
ecma_builtin_date_prototype_dispatch_set (uint16_t builtin_routine_id, /**< built-in wide routine ecma_builtin_date_prototype_dispatch_set (uint16_t builtin_routine_id, /**< built-in wide routine
* identifier */ * identifier */
ecma_extended_object_t *ext_object_p, /**< date extended object */ ecma_extended_object_t *ext_object_p, /**< date extended object */
ecma_number_t date_num, /* date converted to number */ ecma_number_t date_num, /**< date converted to number */
const ecma_value_t arguments_list[], /**< list of arguments const ecma_value_t arguments_list[], /**< list of arguments
* passed to routine */ * passed to routine */
ecma_length_t arguments_number) /**< length of arguments' list */ ecma_length_t arguments_number) /**< length of arguments' list */
@@ -649,4 +649,3 @@ ecma_builtin_date_prototype_dispatch_routine (uint16_t builtin_routine_id, /**<
*/ */
#endif /* !CONFIG_DISABLE_DATE_BUILTIN */ #endif /* !CONFIG_DISABLE_DATE_BUILTIN */
@@ -21,7 +21,7 @@
/** \addtogroup ecma ECMA /** \addtogroup ecma ECMA
* @{ * @{
* *
* \addtogroup ecmaarraybufferobject ECMA Arraybuffer object related routines * \addtogroup ecmaarraybufferobject ECMA ArrayBuffer object related routines
* @{ * @{
*/ */