Method help

lib/jsdoc/opts/argparser.js:185–216

* Generate a summary of all the options with corresponding help text. * @returns {string}

()

     * @returns {string}
     */
    help() {
        const options = {
            names: [],
            descriptions: []
        };

        this._options.forEach(option => {
            let name = '';

            // don't show ignored options
            if (option.ignore) {
                return;
            }

            if (option.shortName) {
                name += `-${option.shortName}${option.longName ? ', ' : ''}`;
            }

            if (option.longName) {
                name += `--${option.longName}`;
            }

            if (option.hasValue) {
                name += ' <value>';
            }

            options.names.push(name);
            options.descriptions.push(option.helpText);
        });

        return `Options:\n${formatHelpInfo(options).join('\n')}`;
    }

    /**
     * Get the options.