add documentation to two predicates

erik-krogh · erik-krogh · commit b2c31701f3cf · 2019-10-27T09:12:56.000+01:00
diff --git a/javascript/ql/src/Statements/UseOfReturnlessFunction.ql b/javascript/ql/src/Statements/UseOfReturnlessFunction.ql
@@ -89,6 +89,9 @@ predicate lastStatementHasNoEffect(Function f) {
   hasNoEffect(f.getExit().getAPredecessor())
 }
 
+/**
+ * Holds if `func` is a callee of `call`, and all possible callees of `call` never return a value.
+ */
 predicate callToVoidFunction(DataFlow::CallNode call, Function func) {
   not call.isIncomplete() and 
   func = call.getACallee() and
@@ -97,6 +100,11 @@ predicate callToVoidFunction(DataFlow::CallNode call, Function func) {
   )
 }
 
+/**
+ * Holds if `name` is the name of a method from `Array.prototype` or Lodash,
+ * where that method takes a callback as parameter,
+ * and the callback is expected to return a value.
+ */
 predicate hasNonVoidCallbackMethod(string name) {
   name = "every" or
   name = "filter" or

Original file line number	Diff line number	Diff line change
`@@ -89,6 +89,9 @@ predicate lastStatementHasNoEffect(Function f) {`
`89`	`89`	`hasNoEffect(f.getExit().getAPredecessor())`
`90`	`90`	`}`
`91`	`91`
	`92`	`+/**`
	`93`	+ * Holds if `func` is a callee of `call`, and all possible callees of `call` never return a value.
	`94`	`+ */`
`92`	`95`	`predicate callToVoidFunction(DataFlow::CallNode call, Function func) {`
`93`	`96`	`not call.isIncomplete() and`
`94`	`97`	`func = call.getACallee() and`
`@@ -97,6 +100,11 @@ predicate callToVoidFunction(DataFlow::CallNode call, Function func) {`
`97`	`100`	`)`
`98`	`101`	`}`
`99`	`102`
	`103`	`+/**`
	`104`	+ * Holds if `name` is the name of a method from `Array.prototype` or Lodash,
	`105`	`+ * where that method takes a callback as parameter,`
	`106`	`+ * and the callback is expected to return a value.`
	`107`	`+ */`
`100`	`108`	`predicate hasNonVoidCallbackMethod(string name) {`
`101`	`109`	`name = "every" or`
`102`	`110`	`name = "filter" or`