Swift: add doc to RegexLiteralExpression

Author: redsun82

swift/ql/.generated.list

@@ -527,7 +527,7 @@ ql/lib/codeql/swift/generated/expr/PrefixUnaryExpr.qll f66dee3c70ed257914de4dd4e
 ql/lib/codeql/swift/generated/expr/PropertyWrapperValuePlaceholderExpr.qll 011897278a75050f1c55bd3f2378b73b447d5882404fd410c9707cd06d226a0e e04b210ab15ffcada94a70d4a1333c348d6d9111697129938c7591364ac88c9f
 ql/lib/codeql/swift/generated/expr/ProtocolMetatypeToObjectExpr.qll b692be6e5b249c095b77f4adcad5760f48bc07f6f53767ee3d236025ee4a2a51 cc69abe3cde83a4cd398ce666509326b21e7ee0b4b766c8dc0e0fea0c7d1ca91
 ql/lib/codeql/swift/generated/expr/RebindSelfInConstructorExpr.qll 7796a88c1635b3bd2492563880c995f1a7a0c68f69bad33b8bd77086eb1ce404 aee11e030ba21115931cbc1e34ac001eaafe4460fb3724a078aa4cbda84e4642
-ql/lib/codeql/swift/generated/expr/RegexLiteralExpr.qll 2bd95d7a900e9d2e21756d54188699e6beedba1e4386300b26eb2fa322be1c6e 33e7070445685ab54704a404ac09548979f244db8f0bac3bea6f8faf22b04a9b
+ql/lib/codeql/swift/generated/expr/RegexLiteralExpr.qll a11eb6f6ce7cebb35ab9ff51eae85f272980140814d7e6bded454069457a1312 bdb4bb65c9f4e187cf743ed13c0213bb7e55db9cc3adeae2169df5e32b003940
 ql/lib/codeql/swift/generated/expr/SelfApplyExpr.qll 8a2d8ee8d0006a519aadbdb9055cfb58a28fd2837f4e3641b357e3b6bda0febe fc64b664b041e57f9ca10d94c59e9723a18d4ff9d70f2389f4c11a2a9f903a6f
 ql/lib/codeql/swift/generated/expr/SequenceExpr.qll 45f976cbc3ce6b3278955a76a55cd0769e69f9bd16e84b40888cd8ebda6be917 ebb090897e4cc4371383aa6771163f73fa2c28f91e6b5f4eed42d7ad018267f3
 ql/lib/codeql/swift/generated/expr/StringLiteralExpr.qll f420c5cd51a223b6f98177147967266e0094a5718ba2d57ae2d3acbb64bbb4b6 30d6dab2a93fd95e652a700902c4d106fecfce13880c2ece565de29f2504bedf
@@ -815,8 +815,6 @@ ql/test/extractor-tests/generated/expr/PropertyWrapperValuePlaceholderExpr/Prope
 ql/test/extractor-tests/generated/expr/PropertyWrapperValuePlaceholderExpr/PropertyWrapperValuePlaceholderExpr_getWrappedValue.ql 208153f062b04bec13a860b64ea51c1d531597140d81a6d4598294dc9f8649a2 dfaea19e1075c02dfc0366fac8fd2edfae8dde06308730eb462c54be5b571129
 ql/test/extractor-tests/generated/expr/RebindSelfInConstructorExpr/MISSING_SOURCE.txt 7e714762ffb48c436102027d560fb5addc1f7dc6dd6936b06e0d3cca031d67fd 7e714762ffb48c436102027d560fb5addc1f7dc6dd6936b06e0d3cca031d67fd
 ql/test/extractor-tests/generated/expr/RegexLiteralExpr/MISSING_SOURCE.txt 7e714762ffb48c436102027d560fb5addc1f7dc6dd6936b06e0d3cca031d67fd 7e714762ffb48c436102027d560fb5addc1f7dc6dd6936b06e0d3cca031d67fd
-ql/test/extractor-tests/generated/expr/RegexLiteralExpr/RegexLiteralExpr.ql 28c679ec360c060fa59137fcdd92d1a70c7c827fd4e0f53aea8460dab54957bc e0a3c9ae9208c852ff61e899d39019994c1bba00b00259e8c99b47905fe28111
-ql/test/extractor-tests/generated/expr/RegexLiteralExpr/RegexLiteralExpr_getType.ql 0df5435c0bb088170400825eb82d934592be2dea19d3d56796a93ed3d2385fc4 653d665751be03d3d083e57121250423b4de50148f8408cc3485dfed8c688083
 ql/test/extractor-tests/generated/expr/StringLiteralExpr/MISSING_SOURCE.txt 7e714762ffb48c436102027d560fb5addc1f7dc6dd6936b06e0d3cca031d67fd 7e714762ffb48c436102027d560fb5addc1f7dc6dd6936b06e0d3cca031d67fd
 ql/test/extractor-tests/generated/expr/SubscriptExpr/MISSING_SOURCE.txt 7e714762ffb48c436102027d560fb5addc1f7dc6dd6936b06e0d3cca031d67fd 7e714762ffb48c436102027d560fb5addc1f7dc6dd6936b06e0d3cca031d67fd
 ql/test/extractor-tests/generated/expr/SuperRefExpr/MISSING_SOURCE.txt 7e714762ffb48c436102027d560fb5addc1f7dc6dd6936b06e0d3cca031d67fd 7e714762ffb48c436102027d560fb5addc1f7dc6dd6936b06e0d3cca031d67fd

swift/ql/lib/codeql/swift/generated/expr/RegexLiteralExpr.qll

@@ -4,18 +4,21 @@ private import codeql.swift.generated.Raw
 import codeql.swift.elements.expr.LiteralExpr
 
 module Generated {
+  /**
+   * A regular expression literal which is checked at compile time, for example `/a(a|b)*b/`.
+   */
   class RegexLiteralExpr extends Synth::TRegexLiteralExpr, LiteralExpr {
     override string getAPrimaryQlClass() { result = "RegexLiteralExpr" }
 
     /**
-     * Gets the pattern of this regex literal expression.
+     * Gets the pattern of this regular expression.
      */
     string getPattern() {
       result = Synth::convertRegexLiteralExprToRaw(this).(Raw::RegexLiteralExpr).getPattern()
     }
 
     /**
-     * Gets the version of this regex literal expression.
+     * Gets the version of the internal regular expression language being used by Swift.
      */
     int getVersion() {
       result = Synth::convertRegexLiteralExprToRaw(this).(Raw::RegexLiteralExpr).getVersion()

swift/schema.py

@@ -689,9 +689,12 @@ class PrefixUnaryExpr(ApplyExpr):
 class ProtocolMetatypeToObjectExpr(ImplicitConversionExpr):
     pass
 
+@ql.default_doc_name("regular expression")
 class RegexLiteralExpr(LiteralExpr):
+    """A regular expression literal which is checked at compile time, for example `/a(a|b)*b/`."""
     pattern: string
-    version: int
+    version: int | doc(
+        "version of the internal regular expression language being used by Swift")
 
 
 @ql.internal