Skip to content

Commit e7dc120

Browse files
committed
Add deprecation comments
1 parent ceb5b4c commit e7dc120

File tree

3 files changed

+33
-0
lines changed

3 files changed

+33
-0
lines changed

javascript/ql/lib/semmle/javascript/frameworks/data/internal/ApiGraphModels.qll

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ private import codeql.dataflow.internal.AccessPathSyntax
7676
/** Module containing hooks for providing input data to be interpreted as a model. */
7777
module ModelInput {
7878
/**
79+
* DEPRECATED: Use the extensible predicate `sourceModel` instead.
80+
*
7981
* A unit class for adding additional source model rows.
8082
*
8183
* Extend this class to add additional source definitions.
@@ -100,6 +102,8 @@ module ModelInput {
100102
* A unit class for adding additional sink model rows.
101103
*
102104
* Extend this class to add additional sink definitions.
105+
*
106+
* DEPRECATED: Use the extensible predicate `sinkModel` instead.
103107
*/
104108
deprecated class SinkModelCsv extends Unit {
105109
/**
@@ -119,6 +123,8 @@ module ModelInput {
119123
* A unit class for adding additional summary model rows.
120124
*
121125
* Extend this class to add additional flow summary definitions.
126+
*
127+
* DEPRECATED: Use the extensible predicate `summaryModel` instead.
122128
*/
123129
deprecated class SummaryModelCsv extends Unit {
124130
/**
@@ -141,6 +147,9 @@ module ModelInput {
141147
* A unit class for adding additional type model rows.
142148
*
143149
* Extend this class to add additional type definitions.
150+
*
151+
* DEPRECATED: Use the extensible predicate `typeModel` or the class
152+
* `TypeModel` instead.
144153
*/
145154
deprecated class TypeModelCsv extends Unit {
146155
/**
@@ -186,6 +195,8 @@ module ModelInput {
186195

187196
/**
188197
* A unit class for adding additional type variable model rows.
198+
*
199+
* DEPRECATED: Use the extensible predicate `typeVariableModel` instead.
189200
*/
190201
deprecated class TypeVariableModelCsv extends Unit {
191202
/**

python/ql/lib/semmle/python/frameworks/data/internal/ApiGraphModels.qll

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ private import codeql.dataflow.internal.AccessPathSyntax
7676
/** Module containing hooks for providing input data to be interpreted as a model. */
7777
module ModelInput {
7878
/**
79+
* DEPRECATED: Use the extensible predicate `sourceModel` instead.
80+
*
7981
* A unit class for adding additional source model rows.
8082
*
8183
* Extend this class to add additional source definitions.
@@ -100,6 +102,8 @@ module ModelInput {
100102
* A unit class for adding additional sink model rows.
101103
*
102104
* Extend this class to add additional sink definitions.
105+
*
106+
* DEPRECATED: Use the extensible predicate `sinkModel` instead.
103107
*/
104108
deprecated class SinkModelCsv extends Unit {
105109
/**
@@ -119,6 +123,8 @@ module ModelInput {
119123
* A unit class for adding additional summary model rows.
120124
*
121125
* Extend this class to add additional flow summary definitions.
126+
*
127+
* DEPRECATED: Use the extensible predicate `summaryModel` instead.
122128
*/
123129
deprecated class SummaryModelCsv extends Unit {
124130
/**
@@ -141,6 +147,9 @@ module ModelInput {
141147
* A unit class for adding additional type model rows.
142148
*
143149
* Extend this class to add additional type definitions.
150+
*
151+
* DEPRECATED: Use the extensible predicate `typeModel` or the class
152+
* `TypeModel` instead.
144153
*/
145154
deprecated class TypeModelCsv extends Unit {
146155
/**
@@ -186,6 +195,8 @@ module ModelInput {
186195

187196
/**
188197
* A unit class for adding additional type variable model rows.
198+
*
199+
* DEPRECATED: Use the extensible predicate `typeVariableModel` instead.
189200
*/
190201
deprecated class TypeVariableModelCsv extends Unit {
191202
/**

ruby/ql/lib/codeql/ruby/frameworks/data/internal/ApiGraphModels.qll

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ private import codeql.dataflow.internal.AccessPathSyntax
7676
/** Module containing hooks for providing input data to be interpreted as a model. */
7777
module ModelInput {
7878
/**
79+
* DEPRECATED: Use the extensible predicate `sourceModel` instead.
80+
*
7981
* A unit class for adding additional source model rows.
8082
*
8183
* Extend this class to add additional source definitions.
@@ -100,6 +102,8 @@ module ModelInput {
100102
* A unit class for adding additional sink model rows.
101103
*
102104
* Extend this class to add additional sink definitions.
105+
*
106+
* DEPRECATED: Use the extensible predicate `sinkModel` instead.
103107
*/
104108
deprecated class SinkModelCsv extends Unit {
105109
/**
@@ -119,6 +123,8 @@ module ModelInput {
119123
* A unit class for adding additional summary model rows.
120124
*
121125
* Extend this class to add additional flow summary definitions.
126+
*
127+
* DEPRECATED: Use the extensible predicate `summaryModel` instead.
122128
*/
123129
deprecated class SummaryModelCsv extends Unit {
124130
/**
@@ -141,6 +147,9 @@ module ModelInput {
141147
* A unit class for adding additional type model rows.
142148
*
143149
* Extend this class to add additional type definitions.
150+
*
151+
* DEPRECATED: Use the extensible predicate `typeModel` or the class
152+
* `TypeModel` instead.
144153
*/
145154
deprecated class TypeModelCsv extends Unit {
146155
/**
@@ -186,6 +195,8 @@ module ModelInput {
186195

187196
/**
188197
* A unit class for adding additional type variable model rows.
198+
*
199+
* DEPRECATED: Use the extensible predicate `typeVariableModel` instead.
189200
*/
190201
deprecated class TypeVariableModelCsv extends Unit {
191202
/**

0 commit comments

Comments
 (0)