From 893cb592b571113f537ed2514b6798a63573b7a7 Mon Sep 17 00:00:00 2001
From: Anders Schack-Mulligen <aschackmull@github.com>
Date: Fri, 23 May 2025 12:35:30 +0200
Subject: [PATCH] SSA: Elaborate qldoc a bit.

---
 shared/ssa/codeql/ssa/Ssa.qll | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/shared/ssa/codeql/ssa/Ssa.qll b/shared/ssa/codeql/ssa/Ssa.qll
index a5f9e3f862b..4734cf7e414 100644
--- a/shared/ssa/codeql/ssa/Ssa.qll
+++ b/shared/ssa/codeql/ssa/Ssa.qll
@@ -1579,6 +1579,14 @@ module Make<LocationSig Location, InputSig<Location> Input> {
        * Holds if this guard evaluating to `branch` controls the control-flow
        * branch edge from `bb1` to `bb2`. That is, following the edge from
        * `bb1` to `bb2` implies that this guard evaluated to `branch`.
+       *
+       * This predicate differs from `hasBranchEdge` in that it also covers
+       * indirect guards, such as:
+       * ```
+       * b = guard;
+       * ...
+       * if (b) { ... }
+       * ```
        */
       predicate controlsBranchEdge(BasicBlock bb1, BasicBlock bb2, boolean branch);
     }