Update QL doc for allowParameterReturnInSelf

This commit is contained in:
Tom Hvitved
2021-10-20 11:03:13 +02:00
parent 53d4d72fe5
commit 0bf5238f39
5 changed files with 25 additions and 10 deletions

View File

@@ -2015,8 +2015,11 @@ predicate additionalLambdaFlowStep(Node nodeFrom, Node nodeTo, boolean preserves
}
/**
* Holds if flow is allowed to pass from parameter `p`, to a return
* node, and back out to `p`.
* Holds if flow is allowed to pass from parameter `p` and back to itself as a
* side-effect, resulting in a summary from `p` to itself.
*
* One example would be to allow flow like `p.foo = p.bar;`, which is disallowed
* by default as a heuristic.
*/
predicate allowParameterReturnInSelf(ParameterNode p) {
FlowSummaryImpl::Private::summaryAllowParameterReturnInSelf(p)