Add qldoc to maybeACompileTimeTemplateArgument

rvermeulen · rvermeulen · commit 5df06ecb6ab3 · 2024-02-15T13:09:40.000-08:00
diff --git a/cpp/common/src/codingstandards/cpp/deadcode/UnusedVariables.qll b/cpp/common/src/codingstandards/cpp/deadcode/UnusedVariables.qll
@@ -123,6 +123,10 @@ class UserProvidedConstructorFieldInit extends ConstructorFieldInit {
   }
 }
 
+/**
+ * Holds if `v` may hold a compile time value and is accessible to a template instantiation that
+ * receives a constant value as an argument equal to the value of `v`.
+ */
 predicate maybeACompileTimeTemplateArgument(Variable v) {
   v.isConstexpr() and
   exists(ClassTemplateInstantiation cti, TranslationUnit tu |

Original file line number	Diff line number	Diff line change
`@@ -123,6 +123,10 @@ class UserProvidedConstructorFieldInit extends ConstructorFieldInit {`
`123`	`123`	`}`
`124`	`124`	`}`
`125`	`125`
	`126`	`+/**`
	`127`	+ * Holds if `v` may hold a compile time value and is accessible to a template instantiation that
	`128`	+ * receives a constant value as an argument equal to the value of `v`.
	`129`	`+ */`
`126`	`130`	`predicate maybeACompileTimeTemplateArgument(Variable v) {`
`127`	`131`	`v.isConstexpr() and`
`128`	`132`	`exists(ClassTemplateInstantiation cti, TranslationUnit tu \|`