Skip to content

Commit 271b23b

Browse files
committed
JS: Expand explanatory comment about version placeholders
1 parent 0c3daab commit 271b23b

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

javascript/ql/lib/semmle/javascript/dependencies/FrameworkLibraries.qll

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,14 @@ abstract class FrameworkLibraryWithMarkerComment extends FrameworkLibrary {
9696
* numbers.
9797
*
9898
* The first capture group of this regular expression should match
99-
* the version number. Any occurrences of the string `<VERSION>` in
100-
* the regular expression will be replaced by `versionRegex()` before
101-
* matching.
99+
* the version number.
100+
*
101+
* Subclasses should implement this predicate.
102+
*
103+
* Callers should avoid using this predicate directly,
104+
* and instead use `getAMarkerCommentRegexWithoutPlaceholders()`,
105+
* which will replace any occurrences of the string `<VERSION>` in
106+
* the regular expression with `versionRegex()`.
102107
*/
103108
abstract string getAMarkerCommentRegex();
104109

0 commit comments

Comments
 (0)