Merge pull request #1008 from ssi02014/refac/utilities

refactor(utilities): adding a jsdoc and reverting an existing jsdoc location

Author: remarkablemark

lib/utilities.js

@@ -36,16 +36,6 @@ function invertObject(obj, override) {
   return result;
 }
 
-/**
- * Check if a given tag is a custom component.
- *
- * @see {@link https://github.com/facebook/react/blob/v16.6.3/packages/react-dom/src/shared/isCustomComponent.js}
- *
- * @param {string} tagName - The name of the html tag.
- * @param {object} props - The props being passed to the element.
- * @returns - Whether tag is custom component.
- */
-
 var RESERVED_SVG_MATHML_ELEMENTS = new Set([
   'annotation-xml',
   'color-profile',
@@ -57,6 +47,15 @@ var RESERVED_SVG_MATHML_ELEMENTS = new Set([
   'missing-glyph'
 ]);
 
+/**
+ * Check if a given tag is a custom component.
+ *
+ * @see {@link https://github.com/facebook/react/blob/v16.6.3/packages/react-dom/src/shared/isCustomComponent.js}
+ *
+ * @param {string} tagName - The name of the html tag.
+ * @param {object} props - The props being passed to the element.
+ * @returns {boolean} - Whether tag is custom component.
+ */
 function isCustomComponent(tagName, props) {
   if (tagName.indexOf('-') === -1) {
     return props && typeof props.is === 'string';
@@ -121,6 +120,12 @@ function canTextBeChildOfNode(node) {
   return !ELEMENTS_WITH_NO_TEXT_CHILDREN.has(node.name);
 }
 
+/**
+ * Returns the first argument as is.
+ *
+ * @param {any} arg - The argument to be returned.
+ * @returns {any} The input argument `arg`.
+ */
 function returnFirstArg(arg) {
   return arg;
 }