JS: Add deprecation qldoc to Configuration classes

This commit is contained in:
Asger F
2024-12-20 15:01:19 +01:00
parent e7d267e5d2
commit df9b95575e
2 changed files with 12 additions and 0 deletions

View File

@@ -76,6 +76,11 @@ private import semmle.javascript.internal.CachedStages
private import AdditionalFlowSteps
/**
* DEPRECATED.
* Subclasses of this class should be replaced by a module implementing the new `ConfigSig` or `StateConfigSig` interface.
* See the [migration guide](https://codeql.github.com/docs/codeql-language-guides/migrating-javascript-dataflow-queries) for more details.
*
* #### Legacy documentation
* A data flow tracking configuration for finding inter-procedural paths from
* sources to sinks.
*

View File

@@ -27,6 +27,13 @@ module TaintTracking {
import AdditionalTaintSteps
/**
* DEPRECATED.
* Subclasses of this class should be replaced by a module implementing the new `ConfigSig` or `StateConfigSig` interface.
* See the [migration guide](https://codeql.github.com/docs/codeql-language-guides/migrating-javascript-dataflow-queries) for more details.
*
* When migrating a `TaintTracking::Configuration` to `DataFlow::ConfigSig`, use `TaintTracking::Global<...>` instead of `DataFlow::Global<...>`.
*
* #### Legacy documentation
* A data flow tracking configuration that considers taint propagation through
* objects, arrays, promises and strings in addition to standard data flow.
*