Add QLDoc for succ0

owen-mc · owen-mc · commit bb4414139057 · 2024-01-03T14:55:56.000Z
diff --git a/go/ql/lib/semmle/go/controlflow/ControlFlowGraphImpl.qll b/go/ql/lib/semmle/go/controlflow/ControlFlowGraphImpl.qll
@@ -623,13 +623,18 @@ module CFG {
       not cmpl.isNormal()
     }
 
+    /**
+     * Holds if `succ` is a successor of `pred`, ignoring the execution of any
+     * deferred functions when a function ends.
+     */
     predicate succ0(ControlFlow::Node pred, ControlFlow::Node succ) {
       exists(int i |
         lastNode(this.getChildTreeRanked(i), pred, normalCompletion()) and
         firstNode(this.getChildTreeRanked(i + 1), succ)
       )
     }
 
+    /** Holds if `succ` is a successor of `pred`. */
     predicate succ(ControlFlow::Node pred, ControlFlow::Node succ) { this.succ0(pred, succ) }
 
     final ControlFlowTree getChildTreeRanked(int i) {
@@ -2080,7 +2085,10 @@ module CFG {
     )
   }
 
-  /** Gets a successor of `nd`, that is, a node that is executed after `nd`. */
+  /**
+   * Gets a successor of `nd`, that is, a node that is executed after `nd`,
+   * ignoring the execution of any deferred functions when a function ends.
+   */
   cached
   private ControlFlow::Node succ0(ControlFlow::Node nd) {
     any(ControlFlowTree tree).succ0(nd, result)

Original file line number	Diff line number	Diff line change
`@@ -623,13 +623,18 @@ module CFG {`
`623`	`623`	`not cmpl.isNormal()`
`624`	`624`	`}`
`625`	`625`
	`626`	`+ /**`
	`627`	+ * Holds if `succ` is a successor of `pred`, ignoring the execution of any
	`628`	`+ * deferred functions when a function ends.`
	`629`	`+ */`
`626`	`630`	`predicate succ0(ControlFlow::Node pred, ControlFlow::Node succ) {`
`627`	`631`	`exists(int i \|`
`628`	`632`	`lastNode(this.getChildTreeRanked(i), pred, normalCompletion()) and`
`629`	`633`	`firstNode(this.getChildTreeRanked(i + 1), succ)`
`630`	`634`	`)`
`631`	`635`	`}`
`632`	`636`
	`637`	+ /** Holds if `succ` is a successor of `pred`. */
`633`	`638`	`predicate succ(ControlFlow::Node pred, ControlFlow::Node succ) { this.succ0(pred, succ) }`
`634`	`639`
`635`	`640`	`final ControlFlowTree getChildTreeRanked(int i) {`
`@@ -2080,7 +2085,10 @@ module CFG {`
`2080`	`2085`	`)`
`2081`	`2086`	`}`
`2082`	`2087`
`2083`		- /** Gets a successor of `nd`, that is, a node that is executed after `nd`. */
	`2088`	`+ /**`
	`2089`	+ * Gets a successor of `nd`, that is, a node that is executed after `nd`,
	`2090`	`+ * ignoring the execution of any deferred functions when a function ends.`
	`2091`	`+ */`
`2084`	`2092`	`cached`
`2085`	`2093`	`private ControlFlow::Node succ0(ControlFlow::Node nd) {`
`2086`	`2094`	`any(ControlFlowTree tree).succ0(nd, result)`