Merge pull request #7532 from Legends/CommentCompilationWarning

CommentCompilationWarning typings
webpack · Jun 23, 2018 · 2bc5437 · 2bc5437
2 parents 4fc03e1 + 2fb9a6c
commit 2bc5437
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/lib/CommentCompilationWarning.js b/lib/CommentCompilationWarning.js
@@ -6,7 +6,17 @@
 
 const WebpackError = require("./WebpackError");
 
+/** @typedef {import("./Module.js")} Module */
+
+/** @typedef {import("./Dependency.js").Loc} Loc */
+
 class CommentCompilationWarning extends WebpackError {
+	/**
+	 *
+	 * @param {string} message warning message
+	 * @param {Module} module affected module
+	 * @param {Loc} loc affected lines of code
+	 */
 	constructor(message, module, loc) {
 		super(message);
 

diff --git a/lib/Dependency.js b/lib/Dependency.js
@@ -7,6 +7,16 @@
 const compareLocations = require("./compareLocations");
 const DependencyReference = require("./dependencies/DependencyReference");
 
+/** @typedef {Object} Position
+ *  @property {number} column
+ *  @property {number} line
+ */
+
+/** @typedef {Object} Loc
+ *  @property {Position} start
+ *  @property {Position} end
+ */
+
 class Dependency {
 	constructor() {
 		this.module = null;