JS: More qldoc

asger-semmle · asger-semmle · commit 2242df920f46 · 2019-11-15T09:27:20.000Z
diff --git a/javascript/ql/src/semmle/javascript/Expr.qll b/javascript/ql/src/semmle/javascript/Expr.qll
@@ -410,7 +410,12 @@ class BigIntLiteral extends @bigintliteral, Literal {
 class StringLiteral extends @stringliteral, Literal {
   override string getStringValue() { result = getValue() }
 
-  /** Gets the value of this string literal parsed as a regular expression. */
+  /**
+   * Gets the value of this string literal parsed as a regular expression, if possible.
+   *
+   * All string literals have an associated regular expression tree, provided it can
+   * be parsed without syntax errors.
+   */
   RegExpTerm asRegExp() { this = result.getParent() }
 }
 
diff --git a/javascript/ql/src/semmle/javascript/Regexp.qll b/javascript/ql/src/semmle/javascript/Regexp.qll
@@ -855,6 +855,9 @@ abstract class RegExpPatternSource extends DataFlow::Node {
    */
   abstract DataFlow::SourceNode getARegExpObject();
 
+  /**
+   * Gets the root term of the regular expression parsed from this pattern.
+   */
   abstract RegExpTerm getRegExpTerm();
 }
 

Original file line number	Diff line number	Diff line change
`@@ -855,6 +855,9 @@ abstract class RegExpPatternSource extends DataFlow::Node {`
`855`	`855`	`*/`
`856`	`856`	`abstract DataFlow::SourceNode getARegExpObject();`
`857`	`857`
	`858`	`+ /**`
	`859`	`+ * Gets the root term of the regular expression parsed from this pattern.`
	`860`	`+ */`
`858`	`861`	`abstract RegExpTerm getRegExpTerm();`
`859`	`862`	`}`
`860`	`863`