C++: Mention 'range-based for-loops' in the QLDoc for 'IRDeclarationEntry'.

MathiasVP · MathiasVP · commit 02c18e714bd8 · 2022-09-06T10:40:13.000+01:00
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/implementation/raw/internal/TranslatedElement.qll b/cpp/ql/lib/semmle/code/cpp/ir/implementation/raw/internal/TranslatedElement.qll
@@ -469,8 +469,10 @@ private module IRDeclarationEntries {
   /**
    * An entity that represents a declaration entry in the database.
    *
-   * This class exists to work around the fact that `DeclStmt`s in
-   * template instantiations do not have `DeclarationEntry`s.
+   * This class exists to work around the fact that `DeclStmt`s in some cases
+   * do not have `DeclarationEntry`s. Currently, this is the case for:
+   * - `DeclStmt`s in template instantiations.
+   * - `DeclStmt`s that are generated by the desugaring of range-based for-loops.
    *
    * So instead, the IR works with `IRDeclarationEntry`s that synthesize missing
    * `DeclarationEntry`s when there is no result for `DeclStmt::getDeclarationEntry`.

Original file line number	Diff line number	Diff line change
`@@ -469,8 +469,10 @@ private module IRDeclarationEntries {`
`469`	`469`	`/**`
`470`	`470`	`* An entity that represents a declaration entry in the database.`
`471`	`471`	`*`
`472`		- * This class exists to work around the fact that `DeclStmt`s in
`473`		- * template instantiations do not have `DeclarationEntry`s.
	`472`	+ * This class exists to work around the fact that `DeclStmt`s in some cases
	`473`	+ * do not have `DeclarationEntry`s. Currently, this is the case for:
	`474`	+ * - `DeclStmt`s in template instantiations.
	`475`	+ * - `DeclStmt`s that are generated by the desugaring of range-based for-loops.
`474`	`476`	`*`
`475`	`477`	* So instead, the IR works with `IRDeclarationEntry`s that synthesize missing
`476`	`478`	* `DeclarationEntry`s when there is no result for `DeclStmt::getDeclarationEntry`.