JS: fix more instances of ql/missing-parameter-qldoc

erik-krogh · erik-krogh · commit daed33f5afe8 · 2022-03-16T22:58:28.000+01:00
diff --git a/javascript/ql/examples/queries/dataflow/TemplateInjection/TemplateInjection.ql b/javascript/ql/examples/queries/dataflow/TemplateInjection/TemplateInjection.ql
@@ -14,7 +14,7 @@ import DataFlow::PathGraph
 /**
  * Gets the name of an unescaped placeholder in a lodash template.
  *
- * For example, the string `<h1><%= title %></h1>` contains the placeholder `title`.
+ * For example, the string "<h1><%= title %></h1>" contains the placeholder "title".
  */
 bindingset[s]
 string getAPlaceholderInString(string s) {
diff --git a/javascript/ql/lib/semmle/javascript/Classes.qll b/javascript/ql/lib/semmle/javascript/Classes.qll
@@ -172,7 +172,7 @@ class ClassDefinition extends @class_definition, ClassOrInterface, AST::ValueNod
   /** Gets the expression denoting the super class of the defined class, if any. */
   override Expr getSuperClass() { result = this.getChildExpr(1) }
 
-  /** Gets the `n`th type from the `implements` clause of this class, starting at 0. */
+  /** Gets the `i`th type from the `implements` clause of this class, starting at 0. */
   override TypeExpr getSuperInterface(int i) {
     // AST indices for super interfaces: -1, -4, -7, ...
     exists(int astIndex | typeexprs(result, _, this, astIndex, _) |
diff --git a/javascript/ql/lib/semmle/javascript/ES2015Modules.qll b/javascript/ql/lib/semmle/javascript/ES2015Modules.qll
@@ -54,7 +54,7 @@ private predicate hasNamedExports(ES2015Module mod) {
 }
 
 /**
- * Holds if this module contains a `default` export.
+ * Holds if this module contains a default export.
  */
 private predicate hasDefaultExport(ES2015Module mod) {
   // export default foo;
diff --git a/javascript/ql/lib/semmle/javascript/PrintAst.qll b/javascript/ql/lib/semmle/javascript/PrintAst.qll
@@ -195,7 +195,7 @@ private module PrintJavaScript {
      * Gets the `i`th child of `element`.
      * Can be overriden in subclasses to get more specific behavior for `getChild()`.
      */
-    AstNode getChildNode(int childIndex) { result = getLocationSortedChild(element, childIndex) }
+    AstNode getChildNode(int i) { result = getLocationSortedChild(element, i) }
   }
 
   /** Provides predicates for pretty printing `AstNode`s. */
diff --git a/javascript/ql/lib/semmle/javascript/Routing.qll b/javascript/ql/lib/semmle/javascript/Routing.qll
@@ -229,7 +229,7 @@ module Routing {
     }
 
     /**
-     * Holds if `node` has processed the incoming request strictly prior to this node.
+     * Holds if `guard` has processed the incoming request strictly prior to this node.
      */
     pragma[inline]
     private predicate isGuardedByNodeInternal(Node guard) {
diff --git a/javascript/ql/lib/semmle/javascript/TypeScript.qll b/javascript/ql/lib/semmle/javascript/TypeScript.qll
@@ -751,7 +751,7 @@ class TypeAccess extends @typeaccess, TypeExpr, TypeRef {
 }
 
 /**
- * Gets a suitable name for the library imported by `import`.
+ * Gets a suitable name for the library imported by `imprt`.
  *
  * For relative imports, this is the snapshot-relative path to the imported module.
  * For non-relative imports, it is the import path itself.
diff --git a/javascript/ql/lib/semmle/javascript/frameworks/Bundling.qll b/javascript/ql/lib/semmle/javascript/frameworks/Bundling.qll
@@ -102,9 +102,9 @@ private predicate isBrowserifyDependencyMap(ObjectExpr deps) {
  * Holds if `m` is a function that looks like a bundled module created
  * by Webpack.
  *
- * Parameters must be named either `module` or `exports`,
- * or their name must contain the substring `webpack_require`
- * or `webpack_module_template_argument`.
+ * Parameters must be named either "module" or "exports",
+ * or their name must contain the substring "webpack_require"
+ * or "webpack_module_template_argument".
  */
 private predicate isWebpackModule(FunctionExpr m) {
   forex(Parameter parm | parm = m.getAParameter() |
diff --git a/javascript/ql/lib/semmle/javascript/frameworks/ConnectExpressShared.qll b/javascript/ql/lib/semmle/javascript/frameworks/ConnectExpressShared.qll
@@ -50,7 +50,7 @@ module ConnectExpressShared {
   }
 
   /**
-   * Holds if `fun` appears to match the given signature based on parameter naming.
+   * Holds if `function` appears to match the given signature based on parameter naming.
    */
   private predicate matchesSignature(Function function, RouteHandlerSignature sig) {
     function.getNumParameter() = sig.getArity() and
diff --git a/javascript/ql/lib/semmle/javascript/frameworks/NoSQL.qll b/javascript/ql/lib/semmle/javascript/frameworks/NoSQL.qll
@@ -584,11 +584,11 @@ private module Minimongo {
    */
   module CollectionMethodSignatures {
     /**
-     * Holds if Collection method `name` interprets parameter `n` as a query.
+     * Holds if Collection method `name` interprets parameter `queryArgIdx` as a query.
      */
-    predicate interpretsArgumentAsQuery(string m, int queryArgIdx) {
+    predicate interpretsArgumentAsQuery(string name, int queryArgIdx) {
       // implements most of the MongoDB interface
-      MongoDB::CollectionMethodSignatures::interpretsArgumentAsQuery(m, queryArgIdx)
+      MongoDB::CollectionMethodSignatures::interpretsArgumentAsQuery(name, queryArgIdx)
     }
   }
 
diff --git a/javascript/ql/lib/semmle/javascript/frameworks/SocketIO.qll b/javascript/ql/lib/semmle/javascript/frameworks/SocketIO.qll
@@ -55,7 +55,7 @@ module SocketIO {
     /** Gets the namespace with the given path of this server. */
     NamespaceObject getNamespace(string path) { result = MkNamespace(this, path) }
 
-    /** Gets a api node that may refer to the socket.io server created at `srv`. */
+    /** Gets a api node that may refer to a socket.io server. */
     private API::Node server() {
       result = node
       or
@@ -144,7 +144,7 @@ module SocketIO {
     override NamespaceObject getNamespace() { result = ns }
 
     /**
-     * Gets a data flow node that may refer to the socket.io namespace created at `ns`.
+     * Gets a data flow node that may refer a the socket.io namespace.
      */
     private API::Node namespace() {
       result = node
diff --git a/javascript/ql/lib/semmle/javascript/frameworks/jQuery.qll b/javascript/ql/lib/semmle/javascript/frameworks/jQuery.qll
@@ -309,12 +309,13 @@ private module JQueryClientRequest {
   /**
    * Gets a node refering to the response contained in an `jqXHR` object.
    */
-  private DataFlow::SourceNode getAResponseNodeFromAnXHRObject(DataFlow::SourceNode obj) {
+  private DataFlow::SourceNode getAResponseNodeFromAnXHRObject(DataFlow::SourceNode jqXHR) {
     result =
-      obj.getAPropertyRead(any(string s |
-          s = "responseText" or
-          s = "responseXML"
-        ))
+      jqXHR
+          .getAPropertyRead(any(string s |
+              s = "responseText" or
+              s = "responseXML"
+            ))
   }
 
   /**
diff --git a/javascript/ql/src/RegExp/RegExpAlwaysMatches.ql b/javascript/ql/src/RegExp/RegExpAlwaysMatches.ql
@@ -39,10 +39,10 @@ RegExpTerm getEffectiveRoot(RegExpTerm actualRoot) {
 /**
  * Holds if `term` contains an anchor on both ends.
  */
-predicate isPossiblyAnchoredOnBothEnds(RegExpSequence node) {
-  node.getAChild*() instanceof RegExpCaret and
-  node.getAChild*() instanceof RegExpDollar and
-  node.getNumChild() >= 2
+predicate isPossiblyAnchoredOnBothEnds(RegExpSequence term) {
+  term.getAChild*() instanceof RegExpCaret and
+  term.getAChild*() instanceof RegExpDollar and
+  term.getNumChild() >= 2
 }
 
 /**
diff --git a/javascript/ql/src/Security/CWE-200/PrivateFileExposure.ql b/javascript/ql/src/Security/CWE-200/PrivateFileExposure.ql
@@ -72,11 +72,11 @@ pragma[noinline]
 Folder getAPackageJsonFolder() { result = any(PackageJson json).getFile().getParentContainer() }
 
 /**
- * Gets a reference to `dirname`, the home folder, the current working folder, or the root folder.
+ * Gets a reference to a directory that has a `package.json` in the same folder, the home folder,
+ * the current working folder, or the root folder.
  * All of these might cause information to be leaked.
  *
- * For `dirname` that can happen if there is a `package.json` file in the same folder.
- * It is assumed that the presence of a `package.json` file means that a `node_modules` folder can also exist.
+ * For the first case it is assumed that the presence of a `package.json` file means that a `node_modules` folder can also exist.
  *
  * For the root/home/working folder, they contain so much information that they must leak information somehow (e.g. ssh keys in the `~/.ssh` folder).
  */
@@ -108,7 +108,7 @@ DataFlow::Node getALeakingFolder(string description) {
 }
 
 /**
- * Gets a data-flow node that represents a path to the private folder `path`.
+ * Gets a data-flow node that represents the private folder descriped by `description`.
  */
 DataFlow::Node getAPrivateFolderPath(string description) {
   exists(string path |
@@ -119,7 +119,7 @@ DataFlow::Node getAPrivateFolderPath(string description) {
 }
 
 /**
- * Gest a call that serves the folder `path` to the public.
+ * Gest a call that serves the folder descriped by `description` to the public.
  */
 DataFlow::CallNode servesAPrivateFolder(string description) {
   result = DataFlow::moduleMember(["express", "connect"], "static").getACall() and
diff --git a/javascript/ql/src/Security/CWE-384/SessionFixation.ql b/javascript/ql/src/Security/CWE-384/SessionFixation.ql
@@ -36,7 +36,7 @@ predicate isLoginSetup(Express::RouteSetup setup) {
 }
 
 /**
- * Holds if `handler` regenerates its session using `req.session.regenerate`.
+ * Holds if `setup` regenerates its session using `req.session.regenerate`.
  */
 pragma[inline]
 predicate regeneratesSession(Express::RouteSetup setup) {

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ import DataFlow::PathGraph`
`14`	`14`	`/**`
`15`	`15`	`* Gets the name of an unescaped placeholder in a lodash template.`
`16`	`16`	`*`
`17`		- * For example, the string `<h1><%= title %></h1>` contains the placeholder `title`.
	`17`	`+ * For example, the string "<h1><%= title %></h1>" contains the placeholder "title".`
`18`	`18`	`*/`
`19`	`19`	`bindingset[s]`
`20`	`20`	`string getAPlaceholderInString(string s) {`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ private predicate hasNamedExports(ES2015Module mod) {`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`/**`
`57`		- * Holds if this module contains a `default` export.
	`57`	`+ * Holds if this module contains a default export.`
`58`	`58`	`*/`
`59`	`59`	`private predicate hasDefaultExport(ES2015Module mod) {`
`60`	`60`	`// export default foo;`
Original file line number	Diff line number	Diff line change
`@@ -195,7 +195,7 @@ private module PrintJavaScript {`
`195`	`195`	* Gets the `i`th child of `element`.
`196`	`196`	* Can be overriden in subclasses to get more specific behavior for `getChild()`.
`197`	`197`	`*/`
`198`		`- AstNode getChildNode(int childIndex) { result = getLocationSortedChild(element, childIndex) }`
	`198`	`+ AstNode getChildNode(int i) { result = getLocationSortedChild(element, i) }`
`199`	`199`	`}`
`200`	`200`
`201`	`201`	/** Provides predicates for pretty printing `AstNode`s. */
Original file line number	Diff line number	Diff line change
`@@ -229,7 +229,7 @@ module Routing {`
`229`	`229`	`}`
`230`	`230`
`231`	`231`	`/**`
`232`		- * Holds if `node` has processed the incoming request strictly prior to this node.
	`232`	+ * Holds if `guard` has processed the incoming request strictly prior to this node.
`233`	`233`	`*/`
`234`	`234`	`pragma[inline]`
`235`	`235`	`private predicate isGuardedByNodeInternal(Node guard) {`
Original file line number	Diff line number	Diff line change
`@@ -751,7 +751,7 @@ class TypeAccess extends @typeaccess, TypeExpr, TypeRef {`
`751`	`751`	`}`
`752`	`752`
`753`	`753`	`/**`
`754`		- * Gets a suitable name for the library imported by `import`.
	`754`	+ * Gets a suitable name for the library imported by `imprt`.
`755`	`755`	`*`
`756`	`756`	`* For relative imports, this is the snapshot-relative path to the imported module.`
`757`	`757`	`* For non-relative imports, it is the import path itself.`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ module ConnectExpressShared {`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`/**`
`53`		- * Holds if `fun` appears to match the given signature based on parameter naming.
	`53`	+ * Holds if `function` appears to match the given signature based on parameter naming.
`54`	`54`	`*/`
`55`	`55`	`private predicate matchesSignature(Function function, RouteHandlerSignature sig) {`
`56`	`56`	`function.getNumParameter() = sig.getArity() and`
Original file line number	Diff line number	Diff line change
`@@ -584,11 +584,11 @@ private module Minimongo {`
`584`	`584`	`*/`
`585`	`585`	`module CollectionMethodSignatures {`
`586`	`586`	`/**`
`587`		- * Holds if Collection method `name` interprets parameter `n` as a query.
	`587`	+ * Holds if Collection method `name` interprets parameter `queryArgIdx` as a query.
`588`	`588`	`*/`
`589`		`- predicate interpretsArgumentAsQuery(string m, int queryArgIdx) {`
	`589`	`+ predicate interpretsArgumentAsQuery(string name, int queryArgIdx) {`
`590`	`590`	`// implements most of the MongoDB interface`
`591`		`- MongoDB::CollectionMethodSignatures::interpretsArgumentAsQuery(m, queryArgIdx)`
	`591`	`+ MongoDB::CollectionMethodSignatures::interpretsArgumentAsQuery(name, queryArgIdx)`
`592`	`592`	`}`
`593`	`593`	`}`
`594`	`594`