Skip to content

Commit 32746d2

Browse files
committed
Add missing QLDoc
1 parent 1fd54b6 commit 32746d2

File tree

1 file changed

+12
-0
lines changed
  • go/ql/lib/semmle/go/dataflow

1 file changed

+12
-0
lines changed

go/ql/lib/semmle/go/dataflow/SSA.qll

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,11 @@ class SsaExplicitDefinition extends SsaDefinition, TExplicitDef {
188188
this.getInstruction().hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
189189
}
190190

191+
/**
192+
* Gets the first instruction that the value of this `SsaDefinition` can
193+
* reach without passing through any other instructions, but possibly through
194+
* phi nodes.
195+
*/
191196
IR::Instruction getAFirstUse() { firstUse(this, result) }
192197
}
193198

@@ -412,4 +417,11 @@ DataFlow::Node getASimilarReadNode(DataFlow::Node node) {
412417
)
413418
}
414419

420+
/**
421+
* Gets an instruction such that `pred` and `result` form an adjacent
422+
* use-use-pair of the same`SsaSourceVariable`, that is, the value read in
423+
* `pred` can reach `result` without passing through any other use or any SSA
424+
* definition of the variable except for phi nodes and uncertain implicit
425+
* updates.
426+
*/
415427
IR::Instruction getAnAdjacentUse(IR::Instruction pred) { adjacentUseUse(pred, result) }

0 commit comments

Comments
 (0)