Skip to content

Commit 066cdb5

Browse files
committed
C++: Add qldoc explaining column order.
1 parent 568724b commit 066cdb5

File tree

3 files changed

+18
-0
lines changed

3 files changed

+18
-0
lines changed

cpp/ql/src/semmle/code/cpp/ir/implementation/aliased_ssa/internal/SSAConstruction.qll

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,12 @@ private module Cached {
338338
instr = unreachedInstruction(_) and result = Language::getVoidType()
339339
}
340340

341+
/**
342+
* Holds if `opcode` is the opcode that specifies the operation performed by `instr`.
343+
*
344+
* The parameters are ordered such that they produce a clean join (with no need for reordering)
345+
* in the characteristic predicates of the `Instruction` subclasses.
346+
*/
341347
cached
342348
predicate getInstructionOpcode(Opcode opcode, Instruction instr) {
343349
opcode = getOldInstruction(instr).getOpcode()

cpp/ql/src/semmle/code/cpp/ir/implementation/unaliased_ssa/internal/SSAConstruction.qll

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,12 @@ private module Cached {
338338
instr = unreachedInstruction(_) and result = Language::getVoidType()
339339
}
340340

341+
/**
342+
* Holds if `opcode` is the opcode that specifies the operation performed by `instr`.
343+
*
344+
* The parameters are ordered such that they produce a clean join (with no need for reordering)
345+
* in the characteristic predicates of the `Instruction` subclasses.
346+
*/
341347
cached
342348
predicate getInstructionOpcode(Opcode opcode, Instruction instr) {
343349
opcode = getOldInstruction(instr).getOpcode()

csharp/ql/src/experimental/ir/implementation/unaliased_ssa/internal/SSAConstruction.qll

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,12 @@ private module Cached {
338338
instr = unreachedInstruction(_) and result = Language::getVoidType()
339339
}
340340

341+
/**
342+
* Holds if `opcode` is the opcode that specifies the operation performed by `instr`.
343+
*
344+
* The parameters are ordered such that they produce a clean join (with no need for reordering)
345+
* in the characteristic predicates of the `Instruction` subclasses.
346+
*/
341347
cached
342348
predicate getInstructionOpcode(Opcode opcode, Instruction instr) {
343349
opcode = getOldInstruction(instr).getOpcode()

0 commit comments

Comments
 (0)