JS: Add missing qldoc

asgerf · asgerf · commit e4f7560bcdfa · 2024-09-12T13:42:14.000+02:00
diff --git a/javascript/ql/lib/semmle/javascript/security/TaintedUrlSuffix.qll b/javascript/ql/lib/semmle/javascript/security/TaintedUrlSuffix.qll
@@ -46,6 +46,12 @@ module TaintedUrlSuffix {
       ]
   }
 
+  /**
+   * Holds if `node` should be a barrier for the given `label`.
+   *
+   * This should be used in the `isBarrier` predicate of a configuration that uses the tainted-url-suffix
+   * label.
+   */
   predicate isBarrier(Node node, FlowLabel label) {
     label = label() and
     DataFlowPrivate::optionalBarrier(node, "tainted-url-suffix")

Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,12 @@ module TaintedUrlSuffix {`
`46`	`46`	`]`
`47`	`47`	`}`
`48`	`48`
	`49`	`+ /**`
	`50`	+ * Holds if `node` should be a barrier for the given `label`.
	`51`	`+ *`
	`52`	+ * This should be used in the `isBarrier` predicate of a configuration that uses the tainted-url-suffix
	`53`	`+ * label.`
	`54`	`+ */`
`49`	`55`	`predicate isBarrier(Node node, FlowLabel label) {`
`50`	`56`	`label = label() and`
`51`	`57`	`DataFlowPrivate::optionalBarrier(node, "tainted-url-suffix")`