Move return annotation to example

Author: Planeshifter

lib/node_modules/@stdlib/utils/flatten-array/lib/gen_fcn.js

@@ -24,6 +24,23 @@
 * @private
 * @param {PositiveIntegerArray} dims - dimensions
 * @returns {Function} flatten function
+*
+* @example
+* var fun = getFcn( 2 );
+* /*
+* * returns
+* *
+* *   function flattenArray( x ) {
+* *       var o = [];
+* *       var i0, i1;
+* *       for ( i0 = 0; i0 < 2; i0++ ) {
+* *           for ( i1 = 0; i1 < 2; i1++ ) {
+* *               o.push( x[i0][i1] );
+* *           }
+* *       }
+* *       return o;
+* *   }
+* *\/
 */
 function genFcn( dims ) {
 	var len;
@@ -73,21 +90,6 @@ function genFcn( dims ) {
 
 	// Create the function in the global scope:
 	return ( new Function( f ) )(); // eslint-disable-line no-new-func
-
-	/*
-	* e.g., returns
-	*
-	*   function flattenArray( x ) {
-	*       var o = [];
-	*       var i0, i1;
-	*       for ( i0 = 0; i0 < 2; i0++ ) {
-	*           for ( i1 = 0; i1 < 2; i1++ ) {
-	*               o.push( x[i0][i1] );
-	*           }
-	*       }
-	*       return o;
-	*   }
-	*/
 }