Skip to content

Commit df9b955

Browse files
committed
JS: Add deprecation qldoc to Configuration classes
1 parent e7d267e commit df9b955

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

javascript/ql/lib/semmle/javascript/dataflow/Configuration.qll

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,11 @@ private import semmle.javascript.internal.CachedStages
7676
private import AdditionalFlowSteps
7777

7878
/**
79+
* DEPRECATED.
80+
* Subclasses of this class should be replaced by a module implementing the new `ConfigSig` or `StateConfigSig` interface.
81+
* See the [migration guide](https://codeql.github.com/docs/codeql-language-guides/migrating-javascript-dataflow-queries) for more details.
82+
*
83+
* #### Legacy documentation
7984
* A data flow tracking configuration for finding inter-procedural paths from
8085
* sources to sinks.
8186
*

javascript/ql/lib/semmle/javascript/dataflow/TaintTracking.qll

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ module TaintTracking {
2727
import AdditionalTaintSteps
2828

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

0 commit comments

Comments
 (0)