diff --git a/lib/node_modules/@stdlib/_tools/licenses/infer/lib/main.js b/lib/node_modules/@stdlib/_tools/licenses/infer/lib/main.js index 8730da082f1c..06e643a10d59 100644 --- a/lib/node_modules/@stdlib/_tools/licenses/infer/lib/main.js +++ b/lib/node_modules/@stdlib/_tools/licenses/infer/lib/main.js @@ -37,10 +37,30 @@ var debug = logger( 'licenses:infer' ); /** * Infers license information from file content. * -* @private * @param {ObjectArray} pkgs - package data * @param {string} pattern - glob pattern * @param {Callback} clbk - callback to invoke upon completion +* +* @example +* var licenses = require( '@stdlib/_tools/licenses/licenses' ); +* +* var pattern = '{readme*,licen[cs]e*,copying*}'; +* +* licenses( onResults ); +* +* function onResults( error, results ) { +* if ( error ) { +* throw error; +* } +* infer( results, pattern, onInfer ); +* } +* +* function onInfer( error, results ) { +* if ( error ) { +* throw error; +* } +* console.dir( results ); +* } */ function infer( pkgs, pattern, clbk ) { var count;