More JSDoc cleanup. [closes #334]

Former-commit-id: dcb55079320e3bcd35c3bf4f36d18f393f16e426
This commit is contained in:
John-David Dalton
2013-08-26 22:01:44 -07:00
parent e322f6dbe2
commit c3f5bc6bfb
23 changed files with 1659 additions and 1631 deletions

View File

@@ -72,16 +72,16 @@
* callback when finished. The `onComplete` callback is invoked with one
* argument; (outputSource).
*
* @param {(string|string[])} [source=''] The source to minify or array of commands.
* @param {string|string[]} [source=''] The source to minify or array of commands.
* -o, --output - Write output to a given path/filename.
* -s, --silent - Skip status updates normally logged to the console.
* -t, --template - Applies template specific minifier options.
*
* @param {object} [options={}] The options object.
* outputPath - Write output to a given path/filename.
* isSilent - Skip status updates normally logged to the console.
* isTemplate - Applies template specific minifier options.
* onComplete - The function called once minification has finished.
* @param {Object} [options={}] The options object.
* @param {string} [options.outputPath] Write output to a given path/filename.
* @param {boolean} [options.isSilent] Skip status updates normally logged to the console.
* @param {boolean} [options.isTemplate] Applies template specific minifier options.
* @param {Function} [options.onComplete] The function called once minification has finished.
*/
function minify(source, options) {
// used to specify the source map URL
@@ -206,7 +206,7 @@
* @private
* @constructor
* @param {string} source The source to minify.
* @param {object} options The options object.
* @param {Object} options The options object.
* outputPath - Write output to a given path/filename.
* isSilent - Skip status updates normally logged to the console.
* isTemplate - Applies template specific minifier options.
@@ -260,7 +260,7 @@
* `git hash-object path/to/dependency.tar.gz`.
*
* @private
* @param {object} options The options object.
* @param {Object} options The options object.
* id - The Git object ID of the `.tar.gz` file.
* onComplete - The function called once the extraction has finished.
* path - The path of the extraction directory.
@@ -333,7 +333,7 @@
* See https://code.google.com/p/closure-compiler/wiki/FAQ#What_are_the_recommended_Java_VM_command-line_options?.
*
* @private
* @param {function} callback The function called once the options have been retrieved.
* @param {Function} callback The function called once the options have been retrieved.
*/
function getJavaOptions(callback) {
var result = [];
@@ -368,7 +368,7 @@
* @private
* @param {string} source The JavaScript source to minify.
* @param {string} mode The optimization mode.
* @param {function} callback The function called once the process has completed.
* @param {Function} callback The function called once the process has completed.
*/
function closureCompile(source, mode, callback) {
var filePath = this.filePath,
@@ -468,7 +468,7 @@
* @private
* @param {string} source The JavaScript source to minify.
* @param {string} label The label to log.
* @param {function} callback The function called once the process has completed.
* @param {Function} callback The function called once the process has completed.
*/
function uglify(source, label, callback) {
if (!this.isSilent) {
@@ -520,7 +520,7 @@
* The Closure Compiler callback for simple optimizations.
*
* @private
* @param {object} [exception] The error object.
* @param {Object} [exception] The error object.
* @param {string} result The resulting minified source.
* @param {string} map The source map output.
*/
@@ -540,7 +540,7 @@
* The Closure Compiler `gzip` callback for simple optimizations.
*
* @private
* @param {object} [exception] The error object.
* @param {Object} [exception] The error object.
* @param {Buffer} result The resulting gzipped source.
*/
function onClosureSimpleGzip(exception, result) {
@@ -565,7 +565,7 @@
* The Closure Compiler callback for advanced optimizations.
*
* @private
* @param {object} [exception] The error object.
* @param {Object} [exception] The error object.
* @param {string} result The resulting minified source.
* @param {string} map The source map output.
*/
@@ -585,7 +585,7 @@
* The Closure Compiler `gzip` callback for advanced optimizations.
*
* @private
* @param {object} [exception] The error object.
* @param {Object} [exception] The error object.
* @param {Buffer} result The resulting gzipped source.
*/
function onClosureAdvancedGzip(exception, result) {
@@ -610,7 +610,7 @@
* The UglifyJS callback.
*
* @private
* @param {object} [exception] The error object.
* @param {Object} [exception] The error object.
* @param {string} result The resulting minified source.
*/
function onUglify(exception, result) {
@@ -626,7 +626,7 @@
* The UglifyJS `gzip` callback.
*
* @private
* @param {object} [exception] The error object.
* @param {Object} [exception] The error object.
* @param {Buffer} result The resulting gzipped source.
*/
function onUglifyGzip(exception, result) {
@@ -656,7 +656,7 @@
* The hybrid callback for simple optimizations.
*
* @private
* @param {object} [exception] The error object.
* @param {Object} [exception] The error object.
* @param {string} result The resulting minified source.
*/
function onSimpleHybrid(exception, result) {
@@ -672,7 +672,7 @@
* The hybrid `gzip` callback for simple optimizations.
*
* @private
* @param {object} [exception] The error object.
* @param {Object} [exception] The error object.
* @param {Buffer} result The resulting gzipped source.
*/
function onSimpleHybridGzip(exception, result) {
@@ -697,7 +697,7 @@
* The hybrid callback for advanced optimizations.
*
* @private
* @param {object} [exception] The error object.
* @param {Object} [exception] The error object.
* @param {string} result The resulting minified source.
*/
function onAdvancedHybrid(exception, result) {
@@ -713,7 +713,7 @@
* The hybrid `gzip` callback for advanced optimizations.
*
* @private
* @param {object} [exception] The error object.
* @param {Object} [exception] The error object.
* @param {Buffer} result The resulting gzipped source.
*/
function onAdvancedHybridGzip(exception, result) {

View File

@@ -274,7 +274,7 @@
* Pre-process a given Lo-Dash `source`, preparing it for minification.
*
* @param {string} [source=''] The source to process.
* @param {object} [options={}] The options object.
* @param {Object} [options={}] The options object.
* @returns {string} Returns the processed source.
*/
function preprocess(source, options) {

View File

@@ -41,7 +41,7 @@
*
* @memberOf util.fs
* @param {string} dirname The path of the directory.
* @param {(number|string)} [mode='0777'] The permission mode.
* @param {number|string} [mode='0777'] The permission mode.
*/
function mkdirpSync(dirname, mode) {
// ensure relative paths are prefixed with `./`
@@ -64,7 +64,7 @@
/**
* The utility object.
*
* @type object
* @type Object
*/
var util = {
@@ -72,7 +72,7 @@
* The file system object.
*
* @memberOf util
* @type object
* @type Object
*/
'fs': _.defaults(_.cloneDeep(fs), {
'existsSync': fs.existsSync || path.existsSync,
@@ -83,7 +83,7 @@
* The path object.
*
* @memberOf util
* @type object
* @type Object
*/
'path': _.defaults(_.cloneDeep(path), {
'sep': sep,