Merge pull request #2895 from max-schaefer/js/improve-param-qldoc

semmle-qlci · web-flow · commit 382e4bc06ada · 2020-02-21T12:01:02.000Z
Approved by asgerf
diff --git a/javascript/ql/src/semmle/javascript/Variables.qll b/javascript/ql/src/semmle/javascript/Variables.qll
@@ -680,14 +680,17 @@ class Parameterized extends @parameterized, Documentable {
 }
 
 /**
- * A parameter declaration.
+ * A parameter declaration in a function or catch clause.
  *
  * Examples:
  *
  * ```
  * function f(x, { y: z }, ...rest) {  // `x`, `{ y: z }` and `rest` are parameter declarations
  *   var [ a, b ] = rest;
  *   var c;
+ *   try {
+ *      x.m();
+ *   } catch(e) {} // `e` is a parameter declaration
  * }
  * ```
  */

Original file line number	Diff line number	Diff line change
`@@ -680,14 +680,17 @@ class Parameterized extends @parameterized, Documentable {`
`680`	`680`	`}`
`681`	`681`
`682`	`682`	`/**`
`683`		`- * A parameter declaration.`
	`683`	`+ * A parameter declaration in a function or catch clause.`
`684`	`684`	`*`
`685`	`685`	`* Examples:`
`686`	`686`	`*`
`687`	`687`	* ```
`688`	`688`	* function f(x, { y: z }, ...rest) { // `x`, `{ y: z }` and `rest` are parameter declarations
`689`	`689`	`* var [ a, b ] = rest;`
`690`	`690`	`* var c;`
	`691`	`+ * try {`
	`692`	`+ * x.m();`
	`693`	+ * } catch(e) {} // `e` is a parameter declaration
`691`	`694`	`* }`
`692`	`695`	* ```
`693`	`696`	`*/`