Skip to content

Commit 1d267ef

Browse files
committed
JS: Fix missing qldoc
1 parent e5924c1 commit 1d267ef

File tree

7 files changed

+16
-6
lines changed

7 files changed

+16
-6
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1762,7 +1762,9 @@ class MidPathNode extends PathNode, MkMidNode {
17621762
predicate isHidden() { PathNode::shouldNodeBeHidden(nd) }
17631763
}
17641764

1765+
/** Companion module to the `PathNode` class. */
17651766
module PathNode {
1767+
/** Holds if `nd` should be hidden in data flow paths. */
17661768
predicate shouldNodeBeHidden(DataFlow::Node nd) {
17671769
// Skip phi, refinement, and capture nodes
17681770
nd.(DataFlow::SsaDefinitionNode).getSsaVariable().getDefinition() instanceof

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ abstract class SummarizedCallable extends LibraryCallable, Impl::Public::Summari
1212
SummarizedCallable() { any() }
1313

1414
// TODO: rename 'propagatesFlowExt' and/or override 'propagatesFlow' directly
15+
/**
16+
* Holds if data may flow from `input` to `output` through this callable.
17+
*
18+
* `preservesValue` indicates whether this is a value-preserving step or a taint-step.
19+
*/
1520
pragma[nomagic]
1621
predicate propagatesFlowExt(string input, string output, boolean preservesValue) { none() }
1722

javascript/ql/lib/semmle/javascript/dataflow/internal/BarrierGuards.qll

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ module MakeStateBarrierGuard<
187187
abstract predicate blocksExpr(boolean outcome, Expr test, FlowState state);
188188
}
189189

190-
class ExplicitBarrierGuard extends BarrierGuard instanceof BaseGuard {
190+
private class ExplicitBarrierGuard extends BarrierGuard instanceof BaseGuard {
191191
override predicate blocksExpr(boolean outcome, Expr test, FlowState state) {
192192
BaseGuard.super.blocksExpr(outcome, test, state)
193193
}

javascript/ql/lib/semmle/javascript/dataflow/internal/DataFlowNode.qll

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,11 +112,9 @@ private class TEarlyStageNode =
112112
* These module systems must therefore use `EarlyStageNode` instead of `DataFlow::Node`.
113113
*/
114114
class EarlyStageNode extends TEarlyStageNode {
115+
/** Gets a string representation of this data flow node. */
115116
string toString() { result = this.(DataFlow::Node).toString() }
116117

117-
predicate hasLocationInfo(
118-
string filepath, int startline, int startcolumn, int endline, int endcolumn
119-
) {
120-
this.(DataFlow::Node).hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
121-
}
118+
/** Gets the location of this data flow node. */
119+
Location getLocation() { result = this.(DataFlow::Node).getLocation() }
122120
}

javascript/ql/lib/semmle/javascript/dataflow/internal/sharedlib/DataFlow.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/** Provides the instantiation of the shared data flow library. */
2+
13
private import semmle.javascript.Locations
24
private import codeql.dataflow.DataFlow
35
private import DataFlowArg

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/** Provides the instantiation of the shared taint tracking library. */
2+
13
private import semmle.javascript.Locations
24
private import codeql.dataflow.TaintTracking
35
private import DataFlowArg

javascript/ql/lib/semmle/javascript/security/dataflow/UnsafeDynamicMethodAccessQuery.qll

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ module UnsafeDynamicMethodAccessConfig implements DataFlow::StateConfigSig {
4343
label.isTaint()
4444
}
4545

46+
/** An additional flow step for use in both this configuration and the legacy configuration. */
4647
additional predicate additionalFlowStep(
4748
DataFlow::Node src, DataFlow::FlowLabel srclabel, DataFlow::Node dst,
4849
DataFlow::FlowLabel dstlabel

0 commit comments

Comments
 (0)