fix jsdoc comments to make eslint happy

sokra · sokra · commit a4e8c07f096b · 2018-04-12T11:42:40.000+02:00
diff --git a/lib/RuntimeTemplate.js b/lib/RuntimeTemplate.js
@@ -14,12 +14,13 @@ module.exports = class RuntimeTemplate {
 
 	/**
 	 * Add a comment
-	 * @param {object} options
-	 * @param {string=} options.request
-	 * @param {string=} options.chunkName
-	 * @param {string=} options.chunkReason
-	 * @param {string=} options.message
-	 * @param {string=} options.exportName
+	 * @param {object} options Information content of the comment
+	 * @param {string=} options.request request string used originally
+	 * @param {string=} options.chunkName name of the chunk referenced
+	 * @param {string=} options.chunkReason reason information of the chunk
+	 * @param {string=} options.message additional message
+	 * @param {string=} options.exportName name of the export
+	 * @return {string} comment
 	 */
 	comment({ request, chunkName, chunkReason, message, exportName }) {
 		let content;
diff --git a/lib/debug/ProfilingPlugin.js b/lib/debug/ProfilingPlugin.js
@@ -320,13 +320,15 @@ const makeInterceptorFor = (instance, tracer) => hookName => ({
 	}
 });
 
+/** @typedef {(...args: any[]) => void | Promise<any>} PluginFunction */
+
 /**
  * @param {string} hookName Name of the hook to profile.
  * @param {{counter: number, trace: *, profiler: *}} tracer Instance of tracer.
  * @param {object} options Options for the profiled fn.
- * @param {string=} options.name
- * @param {string=} options.type
- * @param {(...args: any[]) => Promise<any>} options.fn
+ * @param {string=} options.name Plugin name
+ * @param {string=} options.type Plugin type (sync | async | promise)
+ * @param {PluginFunction} options.fn Plugin function
  * @returns {*} Chainable hooked function.
  */
 const makeNewProfiledTapFn = (hookName, tracer, { name, type, fn }) => {
