Skip to content

Commit 4b4b41b

Browse files
srijan-paulmdjermanovicbmish
authored
fix: update parameter names in JSDocs.
Co-authored-by: Milos Djermanovic <[email protected]> Co-authored-by: Bryan Mishkin <[email protected]>
1 parent 030c505 commit 4b4b41b

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

espree.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ const parsers = {
108108
/**
109109
* Tokenizes the given code.
110110
* @param {string} code The code to tokenize.
111-
* @param {ParserOptions} options Options defining how to tokenize.
111+
* @param {ParserOptions} [options] Options defining how to tokenize.
112112
* @returns {EsprimaToken[]} An array of tokens.
113113
* @throws {SyntaxError} If the input code is invalid.
114114
* @private

lib/espree.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ const ESPRIMA_FINISH_NODE = Symbol("espree's esprimaFinishNode");
1818
* @property {number|undefined} start Start column of a comment.
1919
* @property {number|undefined} end End column of the comment.
2020
* @property {Range|undefined} range The [start, end] range of a comment.
21-
* @property {acorn.Position} startLoc End location of the comment.
21+
* @property {acorn.Position} startLoc Start location of the comment.
2222
* @property {acorn.Position} endLoc End location of the comment.
2323
*/
2424

lib/features.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616

1717
/**
1818
* @typedef {Object} EcmaFeatures
19-
* @property {boolean} jsx
20-
* @property {boolean} globalReturn
21-
* @property {boolean} impliedStrict
19+
* @property {boolean} [jsx]
20+
* @property {boolean} [globalReturn]
21+
* @property {boolean} [impliedStrict]
2222
*/
2323

2424
/**

lib/options.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -87,14 +87,14 @@ function normalizeSourceType(sourceType = "script") {
8787

8888
/**
8989
* @typedef {Object} ParserOptions
90-
* @property {boolean} range Whether to include the range information for each node.
91-
* @property {boolean} loc Whether to include the location information for every node.
92-
* @property {boolean} comments Whether to include an array of all comments
93-
* @property {boolean} tokens Whether to include an array of all tokens
94-
* @property {number|"latest"} ecmaVersion The ECMAScript version to use (between 3 and 13, or 2015 and 2022, or "latest").
95-
* @property {boolean} allowReserved Only allowed when `ecmaVersion` is set to 3.
96-
* @property {"script"|"module"|"commonjs"} sourceType The kind of the source string being parsed.
97-
* @property {EcmaFeatures} ecmaFeatures The additional features to enable.
90+
* @property {boolean} [range] Whether to include the range information for each node.
91+
* @property {boolean} [loc] Whether to include the location information for every node.
92+
* @property {boolean} [comment] Whether to include an array of all comments
93+
* @property {boolean} [tokens] Whether to include an array of all tokens
94+
* @property {number|"latest"} [ecmaVersion] The ECMAScript version to use (between 3 and 13, or 2015 and 2022, or "latest").
95+
* @property {boolean} [allowReserved] Only allowed when `ecmaVersion` is set to 3.
96+
* @property {"script"|"module"|"commonjs"} [sourceType] The kind of the source string being parsed.
97+
* @property {EcmaFeatures} [ecmaFeatures] The additional features to enable.
9898
*/
9999

100100
/**

0 commit comments

Comments
 (0)