refactor: apply (jsdoc-related) eslint rule fixes

brettz9 · Jul 12, 2019 · cd35adb · cd35adb
1 parent e5767d3
commit cd35adb
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 9 deletions.
diff --git a/src/eslint/getJSDocComment.js b/src/eslint/getJSDocComment.js
@@ -1,5 +1,6 @@
 /**
  * Obtained originally from {@link https://github.com/eslint/eslint/blob/master/lib/util/source-code.js#L313}
+ *
  * @license MIT
  */
 

diff --git a/src/iterateJsdoc.js b/src/iterateJsdoc.js
@@ -250,8 +250,8 @@ const getSettings = (context) => {
 /**
  * Create the report function
  *
- * @param {Object} context
- * @param {Object} commentNode
+ * @param {object} context
+ * @param {object} commentNode
  */
 const makeReport = (context, commentNode) => {
   const report = (message, fix = null, jsdocLoc = null, data = null) => {
@@ -378,7 +378,7 @@ export default function iterateJsdoc (iterator, ruleConfig) {
      * @param {*} context
      *   a reference to the context which hold all important information
      *   like settings and the sourcecode to check.
-     * @returns {Object}
+     * @returns {object}
      *   a list with parser callback function.
      */
     create (context) {

diff --git a/src/jsdocUtils.js b/src/jsdocUtils.js
@@ -444,9 +444,9 @@ const lookupTable = {
  * It traverses the parsed source code and returns as
  * soon as it stumbles upon the first return statement.
  *
- * @param {Object} node
+ * @param {object} node
  *   the node which should be checked.
- * @param {Object} context
+ * @param {object} context
  * @param {boolean} ignoreAsync
  *   ignore implicit async return.
  * @returns {boolean}

diff --git a/src/warnRemovedSettings.js b/src/warnRemovedSettings.js
@@ -8,13 +8,13 @@
  * )} RulesWithMovedSettings
  */
 
-/** @type {WeakMap<Object, Set<string>>} */
+/** @type {WeakMap<object, Set<string>>} */
 const warnedSettings = new WeakMap();
 
 /**
  * Warn only once for each context and setting
  *
- * @param {Object} context
+ * @param {object} context
  * @param {string} setting
  */
 const hasBeenWarned = (context, setting) => {
@@ -30,7 +30,7 @@ const markSettingAsWarned = (context, setting) => {
 };
 
 /**
- * @param {Object} obj
+ * @param {object} obj
  * @param {string} property
  * @returns {boolean}
  */
@@ -73,7 +73,7 @@ const getMovedSettings = (ruleName) => {
 };
 
 /**
- * @param {Object} context
+ * @param {object} context
  * @param {RulesWithMovedSettings} ruleName
  */
 export default function warnRemovedSettings (context, ruleName) {