From d220954d972f72dbe50c214422f337dee2e27c7f Mon Sep 17 00:00:00 2001 From: Jeff Williams Date: Wed, 6 Aug 2014 15:23:43 -0700 Subject: [PATCH] doc fixes --- lib/jsdoc/opts/argparser.js | 1 + lib/jsdoc/src/parser.js | 8 ++++---- lib/jsdoc/util/logger.js | 2 +- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/lib/jsdoc/opts/argparser.js b/lib/jsdoc/opts/argparser.js index c33db9d0..b70a45d0 100644 --- a/lib/jsdoc/opts/argparser.js +++ b/lib/jsdoc/opts/argparser.js @@ -14,6 +14,7 @@ var hasOwnProp = Object.prototype.hasOwnProperty; * Create an instance of the parser. * @classdesc A parser to interpret the key-value pairs entered on the command line. * @constructor + * @alias module:jsdoc/opts/argparser */ var ArgParser = function() { this._options = []; diff --git a/lib/jsdoc/src/parser.js b/lib/jsdoc/src/parser.js index 9541219f..1669e03b 100644 --- a/lib/jsdoc/src/parser.js +++ b/lib/jsdoc/src/parser.js @@ -498,8 +498,8 @@ Parser.prototype.resolveEnum = function(e) { * Fired once for each JSDoc comment in the current source code. * @event jsdocCommentFound * @memberof module:jsdoc/src/parser.Parser - * @param {event} e - * @param {string} e.comment The text content of the JSDoc comment - * @param {number} e.lineno The line number associated with the found comment. - * @param {string} e.filename The file name associated with the found comment. + * @type {Object} + * @property {string} comment The text content of the JSDoc comment + * @property {number} lineno The line number associated with the found comment. + * @property {string} filename The file name associated with the found comment. */ diff --git a/lib/jsdoc/util/logger.js b/lib/jsdoc/util/logger.js index b8134d60..98f732e4 100644 --- a/lib/jsdoc/util/logger.js +++ b/lib/jsdoc/util/logger.js @@ -163,7 +163,7 @@ logger.error = wrapLogFunction('error', console.error); /** * Log a message at log level {@link module:jsdoc/util/logger.LEVELS.FATAL}. * - * @name module:jsdoc/util/logger.error + * @name module:jsdoc/util/logger.fatal * @function * @param {string} message - The message to log. * @param {...*=} values - The values that will replace the message's placeholders.