Adding comment to ecma_NewStandardError.

2014-07-15 21:39:24 +04:00
parent 16be2ee3ab
commit c5cfff3d92
1 changed files with 7 additions and 1 deletions
@@ -27,8 +27,14 @@
 * @{
 */

+/**
+ * Standard ecma-error object constructor.
+ *
+ * @return pointer to ecma-object representing specified error
+ *         with reference counter set to one.
+ */
 ecma_Object_t*
-ecma_NewStandardError( ecma_StandardError_t error_type)
+ecma_NewStandardError( ecma_StandardError_t error_type) /**< native error type */
 {
  JERRY_UNIMPLEMENTED_REF_UNUSED_VARS( error_type);
 } /* ecma_NewStandardError */