JS: Mark API as experimental

This commit is contained in:
Asger F
2019-03-06 13:04:34 +00:00
parent 81476cff0b
commit 732ddbcbbd
2 changed files with 11 additions and 1 deletions

View File

@@ -156,6 +156,8 @@ class SourceNode extends DataFlow::Node {
}
/**
* EXPERIMENTAL.
*
* Gets a node that this node may flow to using one heap and/or interprocedural step.
*
* See `TypeTracker` for more details about how to use this.
@@ -168,6 +170,8 @@ class SourceNode extends DataFlow::Node {
}
/**
* EXPERIMENTAL.
*
* Gets a node that may flow into this one using one heap and/or interprocedural step.
*
* See `TypeBackTracker` for more details about how to use this.

View File

@@ -20,6 +20,8 @@ private newtype TStepSummary = MkStepSummary(boolean hasReturn, boolean hasCall)
}
/**
* INTERNAL: Use `TypeTracker` or `TypeBackTracker` instead.
*
* Summary of the steps needed to track a value to a given dataflow node.
*/
class StepSummary extends TStepSummary {
@@ -84,7 +86,7 @@ module StepSummary {
StepSummary return() { result = MkStepSummary(true, false) }
/**
* INTERNAL: Use `SourceNode.track()` instead.
* INTERNAL: Use `SourceNode.track()` or `SourceNode.backtrack()` instead.
*/
predicate step(DataFlow::SourceNode pred, DataFlow::SourceNode succ, StepSummary summary) {
exists (DataFlow::Node predNode | pred.flowsTo(predNode) |
@@ -136,6 +138,8 @@ private newtype TTypeTracker = MkTypeTracker(boolean hasCall) {
}
/**
* EXPERIMENTAL.
*
* Summary of the steps needed to track a value to a given dataflow node.
*
* This can be used to track objects that implement a certain API in order to
@@ -194,6 +198,8 @@ private newtype TTypeBackTracker = MkTypeBackTracker(boolean hasReturn) {
}
/**
* EXPERIMENTAL.
*
* Summary of the steps needed to back-track a use of a value to a given dataflow node.
*
* This can be used to track callbacks that are passed to a certian API call, and are