fix: update parameter names in JSDocs.

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> Co-authored-by: Bryan Mishkin <698306+bmish@users.noreply.github.com>
eslint · Mar 12, 2022 · 4b4b41b · 4b4b41b
1 parent 030c505
commit 4b4b41b
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 13 deletions.
diff --git a/espree.js b/espree.js
@@ -108,7 +108,7 @@ const parsers = {
 /**
  * Tokenizes the given code.
  * @param {string} code The code to tokenize.
- * @param {ParserOptions} options Options defining how to tokenize.
+ * @param {ParserOptions} [options] Options defining how to tokenize.
  * @returns {EsprimaToken[]} An array of tokens.
  * @throws {SyntaxError} If the input code is invalid.
  * @private

diff --git a/lib/espree.js b/lib/espree.js
@@ -18,7 +18,7 @@ const ESPRIMA_FINISH_NODE = Symbol("espree's esprimaFinishNode");
  * @property {number|undefined} start Start column of a comment.
  * @property {number|undefined} end End column of the comment.
  * @property {Range|undefined} range The [start, end] range of a comment.
- * @property {acorn.Position} startLoc End location of the comment.
+ * @property {acorn.Position} startLoc Start location of the comment.
  * @property {acorn.Position} endLoc End location of the comment.
  */
 

diff --git a/lib/features.js b/lib/features.js
@@ -16,9 +16,9 @@
 
 /**
  * @typedef {Object} EcmaFeatures
- * @property {boolean} jsx
- * @property {boolean} globalReturn
- * @property {boolean} impliedStrict
+ * @property {boolean} [jsx]
+ * @property {boolean} [globalReturn]
+ * @property {boolean} [impliedStrict]
  */
 
 /**

diff --git a/lib/options.js b/lib/options.js
@@ -87,14 +87,14 @@ function normalizeSourceType(sourceType = "script") {
 
 /**
  * @typedef {Object} ParserOptions
- * @property {boolean} range Whether to include the range information for each node.
- * @property {boolean} loc Whether to include the location information for every node.
- * @property {boolean} comments Whether to include an array of all comments
- * @property {boolean} tokens Whether to include an array of all tokens
- * @property {number|"latest"} ecmaVersion The ECMAScript version to use (between 3 and 13, or 2015 and 2022, or "latest").
- * @property {boolean} allowReserved Only allowed when `ecmaVersion` is set to 3.
- * @property {"script"|"module"|"commonjs"} sourceType The kind of the source string being parsed.
- * @property {EcmaFeatures} ecmaFeatures The additional features to enable.
+ * @property {boolean} [range] Whether to include the range information for each node.
+ * @property {boolean} [loc] Whether to include the location information for every node.
+ * @property {boolean} [comment] Whether to include an array of all comments
+ * @property {boolean} [tokens] Whether to include an array of all tokens
+ * @property {number|"latest"} [ecmaVersion] The ECMAScript version to use (between 3 and 13, or 2015 and 2022, or "latest").
+ * @property {boolean} [allowReserved] Only allowed when `ecmaVersion` is set to 3.
+ * @property {"script"|"module"|"commonjs"} [sourceType] The kind of the source string being parsed.
+ * @property {EcmaFeatures} [ecmaFeatures] The additional features to enable.
  */
 
 /**