Skip to content

Commit 7b65221

Browse files
author
Esben Sparre Andreasen
committed
JS: address docstring comments
1 parent 1464427 commit 7b65221

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

javascript/ql/src/semmle/javascript/Regexp.qll

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ module RegExpPatterns {
409409
}
410410

411411
/**
412-
* Gets a node whose value may flow (inter-procedurally) to a position where it is interpreted
412+
* Gets a node whose value may flow (inter-procedurally) to `re`, where it is interpreted
413413
* as a part of a regular expression.
414414
*/
415415
private DataFlow::Node regExpSource(DataFlow::Node re, DataFlow::TypeBackTracker t) {
@@ -426,7 +426,7 @@ private DataFlow::Node regExpSource(DataFlow::Node re, DataFlow::TypeBackTracker
426426
}
427427

428428
/**
429-
* Gets a node whose value may flow (inter-procedurally) to a position where it is interpreted
429+
* Gets a node whose value may flow (inter-procedurally) to `re`, where it is interpreted
430430
* as a part of a regular expression.
431431
*/
432432
private DataFlow::Node regExpSource(DataFlow::Node re) {
@@ -439,12 +439,14 @@ private DataFlow::Node regExpSource(DataFlow::Node re) {
439439
*/
440440
abstract class RegExpPatternSource extends DataFlow::Node {
441441
/**
442-
* Gets the pattern of this node.
442+
* Gets the pattern of this node that is interpreted as a part of a
443+
* regular expression.
443444
*/
444445
abstract string getPattern();
445446

446447
/**
447-
* Gets a regular expression object that is built from the value of this node.
448+
* Gets a regular expression object that is constructed from the pattern
449+
* of this node.
448450
*/
449451
abstract DataFlow::SourceNode getARegExpObject();
450452
}
@@ -477,7 +479,7 @@ class StringRegExpPatternSource extends RegExpPatternSource {
477479
StringRegExpPatternSource() { this = regExpSource(use) }
478480

479481
/**
480-
* Gets a node that use this source as a regular expression pattern.
482+
* Gets a node that uses this source as a regular expression pattern.
481483
*/
482484
DataFlow::Node getAUse() { result = use }
483485

0 commit comments

Comments
 (0)