C++/C#: Document IRPositionalParameter

Robert Marsh · Robert Marsh · commit 2a96856ca558 · 2020-06-08T12:41:26.000-07:00
diff --git a/cpp/ql/src/semmle/code/cpp/ir/implementation/aliased_ssa/IRVariable.qll b/cpp/ql/src/semmle/code/cpp/ir/implementation/aliased_ssa/IRVariable.qll
@@ -298,6 +298,9 @@ class IRParameter extends IRAutomaticVariable {
   int getIndex() { none() }
 }
 
+/**
+ * An IR variable representing a positional parameter.
+ */
 class IRPositionalParameter extends IRParameter, IRAutomaticUserVariable {
   final override int getIndex() { result = getVariable().(Language::Parameter).getIndex() }
 }
diff --git a/cpp/ql/src/semmle/code/cpp/ir/implementation/raw/IRVariable.qll b/cpp/ql/src/semmle/code/cpp/ir/implementation/raw/IRVariable.qll
@@ -298,6 +298,9 @@ class IRParameter extends IRAutomaticVariable {
   int getIndex() { none() }
 }
 
+/**
+ * An IR variable representing a positional parameter.
+ */
 class IRPositionalParameter extends IRParameter, IRAutomaticUserVariable {
   final override int getIndex() { result = getVariable().(Language::Parameter).getIndex() }
 }
diff --git a/cpp/ql/src/semmle/code/cpp/ir/implementation/unaliased_ssa/IRVariable.qll b/cpp/ql/src/semmle/code/cpp/ir/implementation/unaliased_ssa/IRVariable.qll
@@ -298,6 +298,9 @@ class IRParameter extends IRAutomaticVariable {
   int getIndex() { none() }
 }
 
+/**
+ * An IR variable representing a positional parameter.
+ */
 class IRPositionalParameter extends IRParameter, IRAutomaticUserVariable {
   final override int getIndex() { result = getVariable().(Language::Parameter).getIndex() }
 }
diff --git a/csharp/ql/src/semmle/code/csharp/ir/implementation/raw/IRVariable.qll b/csharp/ql/src/semmle/code/csharp/ir/implementation/raw/IRVariable.qll
@@ -298,6 +298,9 @@ class IRParameter extends IRAutomaticVariable {
   int getIndex() { none() }
 }
 
+/**
+ * An IR variable representing a positional parameter.
+ */
 class IRPositionalParameter extends IRParameter, IRAutomaticUserVariable {
   final override int getIndex() { result = getVariable().(Language::Parameter).getIndex() }
 }
diff --git a/csharp/ql/src/semmle/code/csharp/ir/implementation/unaliased_ssa/IRVariable.qll b/csharp/ql/src/semmle/code/csharp/ir/implementation/unaliased_ssa/IRVariable.qll
@@ -298,6 +298,9 @@ class IRParameter extends IRAutomaticVariable {
   int getIndex() { none() }
 }
 
+/**
+ * An IR variable representing a positional parameter.
+ */
 class IRPositionalParameter extends IRParameter, IRAutomaticUserVariable {
   final override int getIndex() { result = getVariable().(Language::Parameter).getIndex() }
 }

Original file line number	Diff line number	Diff line change
`@@ -298,6 +298,9 @@ class IRParameter extends IRAutomaticVariable {`
`298`	`298`	`int getIndex() { none() }`
`299`	`299`	`}`
`300`	`300`
	`301`	`+/**`
	`302`	`+ * An IR variable representing a positional parameter.`
	`303`	`+ */`
`301`	`304`	`class IRPositionalParameter extends IRParameter, IRAutomaticUserVariable {`
`302`	`305`	`final override int getIndex() { result = getVariable().(Language::Parameter).getIndex() }`
`303`	`306`	`}`