Skip to content

Improve JSDoc to match code #1132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
abetomo merged 1 commit into from
Jan 4, 2020
Merged

Improve JSDoc to match code #1132

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ exports.CommanderError = CommanderError;
/**
* Initialize a new `Command`.
*
* @param {String} name
* @param {String} [name]
* @api public
*/

Expand Down Expand Up @@ -694,7 +694,7 @@ Command.prototype.parse = function(argv) {
* @param {Array} argv
* @param {Array} args
* @param {Array} unknown
* @param {String} specifySubcommand
* @param {String} executableFile
* @api private
*/

Expand Down Expand Up @@ -927,7 +927,7 @@ Command.prototype._checkForMissingMandatoryOptions = function() {
* void of these options.
*
* @param {Array} argv
* @return {Array}
* @return {{args: Array, unknown: Array}}
Comment thread
shadowspawn marked this conversation as resolved.
* @api public
*/

Expand Down Expand Up @@ -1039,8 +1039,8 @@ Command.prototype.missingArgument = function(name) {
/**
* `Option` is missing an argument, but received `flag` or nothing.
*
* @param {String} option
* @param {String} flag
* @param {Option} option
* @param {String} [flag]
* @api private
*/

Expand All @@ -1058,7 +1058,7 @@ Command.prototype.optionMissingArgument = function(option, flag) {
/**
* `Option` does not have a value, and is a mandatory option.
*
* @param {String} option
* @param {Option} option
* @api private
*/

Expand Down Expand Up @@ -1130,7 +1130,7 @@ Command.prototype.version = function(str, flags, description) {
* Set the description to `str`.
*
* @param {String} str
* @param {Object} argsDescription
* @param {Object} [argsDescription]
* @return {String|Command}
* @api public
*/
Expand Down Expand Up @@ -1167,7 +1167,7 @@ Command.prototype.alias = function(alias) {
/**
* Set / get the command usage `str`.
*
* @param {String} str
* @param {String} [str]
* @return {String|Command}
* @api public
*/
Expand All @@ -1190,7 +1190,7 @@ Command.prototype.usage = function(str) {
/**
* Get or set the name of the command
*
* @param {String} str
* @param {String} [str]
* @return {String|Command}
* @api public
*/
Expand Down Expand Up @@ -1536,8 +1536,8 @@ function optionalWrap(str, width, indent) {
/**
* Output help information if necessary
*
* @param {Command} command to output help for
* @param {Array} array of options to search for -h or --help
* @param {Command} cmd - command to output help for
* @param {Array} options - array of options to search for -h or --help
* @api private
*/

Expand Down