add createElement jsdoc

xmppjs · Jun 6, 2016 · 56365a0 · 56365a0
1 parent f9d259b
commit 56365a0
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/lib/createElement.js b/lib/createElement.js
@@ -1,9 +1,15 @@
 'use strict'
 
-// JSX compatible
-
 var Element = require('./Element')
 
+/**
+ * JSX compatible API, use this function as pragma
+ * https://facebook.github.io/jsx/
+ *
+ * @param  {string} name  name of the element
+ * @param  {object} attrs object of attribute key/value pairs
+ * @return {Element}      Element
+ */
 module.exports = function createElement (name, attrs /*, child1, child2, ...*/) {
   var el = new Element(name, attrs)