Skip to content

Commit cd35adb

Browse files
committed
refactor: apply (jsdoc-related) eslint rule fixes
1 parent e5767d3 commit cd35adb

File tree

4 files changed

+10
-9
lines changed

4 files changed

+10
-9
lines changed

src/eslint/getJSDocComment.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
/**
22
* Obtained originally from {@link https://github.com/eslint/eslint/blob/master/lib/util/source-code.js#L313}
3+
*
34
* @license MIT
45
*/
56

src/iterateJsdoc.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -250,8 +250,8 @@ const getSettings = (context) => {
250250
/**
251251
* Create the report function
252252
*
253-
* @param {Object} context
254-
* @param {Object} commentNode
253+
* @param {object} context
254+
* @param {object} commentNode
255255
*/
256256
const makeReport = (context, commentNode) => {
257257
const report = (message, fix = null, jsdocLoc = null, data = null) => {
@@ -378,7 +378,7 @@ export default function iterateJsdoc (iterator, ruleConfig) {
378378
* @param {*} context
379379
* a reference to the context which hold all important information
380380
* like settings and the sourcecode to check.
381-
* @returns {Object}
381+
* @returns {object}
382382
* a list with parser callback function.
383383
*/
384384
create (context) {

src/jsdocUtils.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -444,9 +444,9 @@ const lookupTable = {
444444
* It traverses the parsed source code and returns as
445445
* soon as it stumbles upon the first return statement.
446446
*
447-
* @param {Object} node
447+
* @param {object} node
448448
* the node which should be checked.
449-
* @param {Object} context
449+
* @param {object} context
450450
* @param {boolean} ignoreAsync
451451
* ignore implicit async return.
452452
* @returns {boolean}

src/warnRemovedSettings.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@
88
* )} RulesWithMovedSettings
99
*/
1010

11-
/** @type {WeakMap<Object, Set<string>>} */
11+
/** @type {WeakMap<object, Set<string>>} */
1212
const warnedSettings = new WeakMap();
1313

1414
/**
1515
* Warn only once for each context and setting
1616
*
17-
* @param {Object} context
17+
* @param {object} context
1818
* @param {string} setting
1919
*/
2020
const hasBeenWarned = (context, setting) => {
@@ -30,7 +30,7 @@ const markSettingAsWarned = (context, setting) => {
3030
};
3131

3232
/**
33-
* @param {Object} obj
33+
* @param {object} obj
3434
* @param {string} property
3535
* @returns {boolean}
3636
*/
@@ -73,7 +73,7 @@ const getMovedSettings = (ruleName) => {
7373
};
7474

7575
/**
76-
* @param {Object} context
76+
* @param {object} context
7777
* @param {RulesWithMovedSettings} ruleName
7878
*/
7979
export default function warnRemovedSettings (context, ruleName) {

0 commit comments

Comments
 (0)