C++: Add missing QLDoc.

MathiasVP · MathiasVP · commit e0a6c1622853 · 2022-11-11T11:09:38.000Z
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowUtil.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowUtil.qll
@@ -646,6 +646,7 @@ private class RawIndirectOperand extends Node, TRawIndirectOperand {
   /** Gets the underlying instruction. */
   Operand getOperand() { result = operand }
 
+  /** Gets the underlying indirection index. */
   int getIndirectionIndex() { result = indirectionIndex }
 
   override Function getFunction() { result = this.getOperand().getDef().getEnclosingFunction() }
@@ -665,6 +666,15 @@ private class RawIndirectOperand extends Node, TRawIndirectOperand {
   }
 }
 
+/**
+ * INTERNAL: Do not use.
+ *
+ * A node that represents the indirect value of an operand in the IR
+ * after `index` number of loads.
+ *
+ * Note: Unlike `RawIndirectOperand`, a value of type `IndirectOperand` may
+ * be an `OperandNode`.
+ */
 class IndirectOperand extends Node {
   Operand operand;
   int indirectionIndex;
@@ -677,10 +687,16 @@ class IndirectOperand extends Node {
       Ssa::getIRRepresentationOfIndirectOperand(operand, indirectionIndex)
   }
 
+  /** Gets the underlying operand. */
   Operand getOperand() { result = operand }
 
+  /** Gets the underlying indirection index. */
   int getIndirectionIndex() { result = indirectionIndex }
 
+  /**
+   * Holds if this `IndirectOperand` is represented directly in the IR instead of
+   * a `RawIndirectionOperand` with operand `op` and indirection index `index`.
+   */
   predicate isIRRepresentationOf(Operand op, int index) {
     this instanceof OperandNode and
     (
@@ -724,6 +740,7 @@ private class RawIndirectInstruction extends Node, TRawIndirectInstruction {
   /** Gets the underlying instruction. */
   Instruction getInstruction() { result = instr }
 
+  /** Gets the underlying indirection index. */
   int getIndirectionIndex() { result = indirectionIndex }
 
   override Function getFunction() { result = this.getInstruction().getEnclosingFunction() }
@@ -743,6 +760,15 @@ private class RawIndirectInstruction extends Node, TRawIndirectInstruction {
   }
 }
 
+/**
+ * INTERNAL: Do not use.
+ *
+ * A node that represents the indirect value of an instruction in the IR
+ * after `index` number of loads.
+ *
+ * Note: Unlike `RawIndirectInstruction`, a value of type `IndirectInstruction` may
+ * be an `InstructionNode`.
+ */
 class IndirectInstruction extends Node {
   Instruction instr;
   int indirectionIndex;
@@ -755,10 +781,16 @@ class IndirectInstruction extends Node {
       Ssa::getIRRepresentationOfIndirectInstruction(instr, indirectionIndex)
   }
 
+  /** Gets the underlying instruction. */
   Instruction getInstruction() { result = instr }
 
+  /** Gets the underlying indirection index. */
   int getIndirectionIndex() { result = indirectionIndex }
 
+  /**
+   * Holds if this `IndirectInstruction` is represented directly in the IR instead of
+   * a `RawIndirectionInstruction` with instruction `i` and indirection index `index`.
+   */
   predicate isIRRepresentationOf(Instruction i, int index) {
     this instanceof InstructionNode and
     (
