Java: QLDoc.

Author: geoffw0

java/ql/lib/semmle/code/java/regex/regex.qll

@@ -472,13 +472,23 @@ abstract class RegexString extends StringLiteral {
     )
   }
 
+  /**
+   * Holds if a parse mode starts between `start` and `end`.
+   */
   private predicate flagGroupStart(int start, int end) {
     this.isGroupStart(start) and
     this.getChar(start + 1) = "?" and
     this.getChar(start + 2) in ["i", "m", "s", "u", "x", "U"] and
     end = start + 2
   }
 
+  /**
+   * Holds if a parse mode group is between `start` and `end`, and includes the
+   * mode flag `c`. For example the following span, with mode flag `i`:
+   * ```
+   * (?i)
+   * ```
+   */
   private predicate flagGroup(int start, int end, string c) {
     exists(int inStart, int inEnd |
       this.flagGroupStart(start, inStart) and