Shared: update qldocs

csharp/ql/lib/semmle/code/csharp/dataflow/ExternalFlow.qll

@@ -205,6 +205,7 @@ module ModelValidation {
     )
   }
 
+  /** Gets an error message relating to an invalid kind in a model. */
   private string getInvalidModelKind() {
     exists(string kind | summaryModel(_, _, _, _, _, _, _, _, kind, _) |
       not kind instanceof ValidSummaryKind and

csharp/ql/lib/semmle/code/csharp/dataflow/SharedModelValidation.qll

@@ -1,7 +1,7 @@
 /**
  * INTERNAL: Do not use.
  *
- * Provides classes for validating kinds in models as data rows.
+ * Provides classes and predicates related to validating models as data rows.
  * Such that we can share this logic across our CodeQL analysis of different languages.
  */
 
@@ -40,6 +40,7 @@ class ValidSinkKind extends string {
   }
 }
 
+/** An outdated models-as-data sink kind. */
 class OutdatedSinkKind extends string {
   OutdatedSinkKind() {
     this =
@@ -51,6 +52,7 @@ class OutdatedSinkKind extends string {
       ]
   }
 
+  /** Gets a replacement kind for an outdated sink kind. */
   private string replacementKind() {
     this = ["sql", "xpath", "groovy", "jexl", "mvel", "xslt", "ldap", "code", "html"] and
     result = this + "-injection"
@@ -84,6 +86,7 @@ class OutdatedSinkKind extends string {
     this = "uncontrolled-format-string" and result = "format-string"
   }
 
+  /** Gets an error message for an outdated sink kind. */
   string outdatedMessage() {
     result =
       "The kind \"" + this + "\" is outdated. Use \"" + this.replacementKind() + "\" instead."

go/ql/lib/semmle/go/dataflow/ExternalFlow.qll

@@ -189,6 +189,7 @@ module ModelValidation {
     )
   }
 
+  /** Gets an error message relating to an invalid kind in a model. */
   private string getInvalidModelKind() {
     exists(string kind | summaryModel(_, _, _, _, _, _, _, _, kind, _) |
       not kind instanceof ValidSummaryKind and

go/ql/lib/semmle/go/dataflow/SharedModelValidation.qll

@@ -1,7 +1,7 @@
 /**
  * INTERNAL: Do not use.
  *
- * Provides classes for validating kinds in models as data rows.
+ * Provides classes and predicates related to validating models as data rows.
  * Such that we can share this logic across our CodeQL analysis of different languages.
  */
 
@@ -40,6 +40,7 @@ class ValidSinkKind extends string {
   }
 }
 
+/** An outdated models-as-data sink kind. */
 class OutdatedSinkKind extends string {
   OutdatedSinkKind() {
     this =
@@ -51,6 +52,7 @@ class OutdatedSinkKind extends string {
       ]
   }
 
+  /** Gets a replacement kind for an outdated sink kind. */
   private string replacementKind() {
     this = ["sql", "xpath", "groovy", "jexl", "mvel", "xslt", "ldap", "code", "html"] and
     result = this + "-injection"
@@ -84,6 +86,7 @@ class OutdatedSinkKind extends string {
     this = "uncontrolled-format-string" and result = "format-string"
   }
 
+  /** Gets an error message for an outdated sink kind. */
   string outdatedMessage() {
     result =
       "The kind \"" + this + "\" is outdated. Use \"" + this.replacementKind() + "\" instead."

java/ql/lib/semmle/code/java/dataflow/ExternalFlow.qll

@@ -266,6 +266,7 @@ module ModelValidation {
     )
   }
 
+  /** Gets an error message relating to an invalid kind in a model. */
   private string getInvalidModelKind() {
     exists(string kind | summaryModel(_, _, _, _, _, _, _, _, kind, _) |
       not kind instanceof ValidSummaryKind and

java/ql/lib/semmle/code/java/dataflow/SharedModelValidation.qll

@@ -1,7 +1,7 @@
 /**
  * INTERNAL: Do not use.
  *
- * Provides classes for validating kinds in models as data rows.
+ * Provides classes and predicates related to validating models as data rows.
  * Such that we can share this logic across our CodeQL analysis of different languages.
  */
 
@@ -40,6 +40,7 @@ class ValidSinkKind extends string {
   }
 }
 
+/** An outdated models-as-data sink kind. */
 class OutdatedSinkKind extends string {
   OutdatedSinkKind() {
     this =
@@ -51,6 +52,7 @@ class OutdatedSinkKind extends string {
       ]
   }
 
+  /** Gets a replacement kind for an outdated sink kind. */
   private string replacementKind() {
     this = ["sql", "xpath", "groovy", "jexl", "mvel", "xslt", "ldap", "code", "html"] and
     result = this + "-injection"
@@ -84,6 +86,7 @@ class OutdatedSinkKind extends string {
     this = "uncontrolled-format-string" and result = "format-string"
   }
 
+  /** Gets an error message for an outdated sink kind. */
   string outdatedMessage() {
     result =
       "The kind \"" + this + "\" is outdated. Use \"" + this.replacementKind() + "\" instead."

javascript/ql/lib/semmle/javascript/frameworks/data/internal/ApiGraphModels.qll

@@ -655,6 +655,7 @@ module ModelOutput {
   import Specific::ModelOutputSpecific
   private import SharedModelValidation
 
+  /** Gets an error message relating to an invalid kind in a model. */
   private string getInvalidModelKind() {
     exists(string kind | summaryModel(_, _, _, _, kind) |
       not kind instanceof ValidSummaryKind and

javascript/ql/lib/semmle/javascript/frameworks/data/internal/SharedModelValidation.qll

@@ -1,7 +1,7 @@
 /**
  * INTERNAL: Do not use.
  *
- * Provides classes for validating kinds in models as data rows.
+ * Provides classes and predicates related to validating models as data rows.
  * Such that we can share this logic across our CodeQL analysis of different languages.
  */
 
@@ -40,6 +40,7 @@ class ValidSinkKind extends string {
   }
 }
 
+/** An outdated models-as-data sink kind. */
 class OutdatedSinkKind extends string {
   OutdatedSinkKind() {
     this =
@@ -51,6 +52,7 @@ class OutdatedSinkKind extends string {
       ]
   }
 
+  /** Gets a replacement kind for an outdated sink kind. */
   private string replacementKind() {
     this = ["sql", "xpath", "groovy", "jexl", "mvel", "xslt", "ldap", "code", "html"] and
     result = this + "-injection"
@@ -84,6 +86,7 @@ class OutdatedSinkKind extends string {
     this = "uncontrolled-format-string" and result = "format-string"
   }
 
+  /** Gets an error message for an outdated sink kind. */
   string outdatedMessage() {
     result =
       "The kind \"" + this + "\" is outdated. Use \"" + this.replacementKind() + "\" instead."

python/ql/lib/semmle/python/frameworks/data/internal/ApiGraphModels.qll

@@ -655,6 +655,7 @@ module ModelOutput {
   import Specific::ModelOutputSpecific
   private import SharedModelValidation
 
+  /** Gets an error message relating to an invalid kind in a model. */
   private string getInvalidModelKind() {
     exists(string kind | summaryModel(_, _, _, _, kind) |
       not kind instanceof ValidSummaryKind and

python/ql/lib/semmle/python/frameworks/data/internal/SharedModelValidation.qll

@@ -1,7 +1,7 @@
 /**
  * INTERNAL: Do not use.
  *
- * Provides classes for validating kinds in models as data rows.
+ * Provides classes and predicates related to validating models as data rows.
  * Such that we can share this logic across our CodeQL analysis of different languages.
  */
 
@@ -40,6 +40,7 @@ class ValidSinkKind extends string {
   }
 }
 
+/** An outdated models-as-data sink kind. */
 class OutdatedSinkKind extends string {
   OutdatedSinkKind() {
     this =
@@ -51,6 +52,7 @@ class OutdatedSinkKind extends string {
       ]
   }
 
+  /** Gets a replacement kind for an outdated sink kind. */
   private string replacementKind() {
     this = ["sql", "xpath", "groovy", "jexl", "mvel", "xslt", "ldap", "code", "html"] and
     result = this + "-injection"
@@ -84,6 +86,7 @@ class OutdatedSinkKind extends string {
     this = "uncontrolled-format-string" and result = "format-string"
   }
 
+  /** Gets an error message for an outdated sink kind. */
   string outdatedMessage() {
     result =
       "The kind \"" + this + "\" is outdated. Use \"" + this.replacementKind() + "\" instead."

ruby/ql/lib/codeql/ruby/frameworks/data/internal/ApiGraphModels.qll

@@ -655,6 +655,7 @@ module ModelOutput {
   import Specific::ModelOutputSpecific
   private import SharedModelValidation
 
+  /** Gets an error message relating to an invalid kind in a model. */
   private string getInvalidModelKind() {
     exists(string kind | summaryModel(_, _, _, _, kind) |
       not kind instanceof ValidSummaryKind and

ruby/ql/lib/codeql/ruby/frameworks/data/internal/SharedModelValidation.qll

@@ -1,7 +1,7 @@
 /**
  * INTERNAL: Do not use.
  *
- * Provides classes for validating kinds in models as data rows.
+ * Provides classes and predicates related to validating models as data rows.
  * Such that we can share this logic across our CodeQL analysis of different languages.
  */
 
@@ -40,6 +40,7 @@ class ValidSinkKind extends string {
   }
 }
 
+/** An outdated models-as-data sink kind. */
 class OutdatedSinkKind extends string {
   OutdatedSinkKind() {
     this =
@@ -51,6 +52,7 @@ class OutdatedSinkKind extends string {
       ]
   }
 
+  /** Gets a replacement kind for an outdated sink kind. */
   private string replacementKind() {
     this = ["sql", "xpath", "groovy", "jexl", "mvel", "xslt", "ldap", "code", "html"] and
     result = this + "-injection"
@@ -84,6 +86,7 @@ class OutdatedSinkKind extends string {
     this = "uncontrolled-format-string" and result = "format-string"
   }
 
+  /** Gets an error message for an outdated sink kind. */
   string outdatedMessage() {
     result =
       "The kind \"" + this + "\" is outdated. Use \"" + this.replacementKind() + "\" instead."

swift/ql/lib/codeql/swift/dataflow/ExternalFlow.qll

@@ -264,6 +264,7 @@ module CsvValidation {
     )
   }
 
+  /** Gets an error message relating to an invalid kind in a model. */
   private string getInvalidModelKind() {
     exists(string row, string kind | summaryModel(row) |
       kind = row.splitAt(";", 8) and

swift/ql/lib/codeql/swift/dataflow/SharedModelValidation.qll

@@ -1,7 +1,7 @@
 /**
  * INTERNAL: Do not use.
  *
- * Provides classes for validating kinds in models as data rows.
+ * Provides classes and predicates related to validating models as data rows.
  * Such that we can share this logic across our CodeQL analysis of different languages.
  */
 
@@ -40,6 +40,7 @@ class ValidSinkKind extends string {
   }
 }
 
+/** An outdated models-as-data sink kind. */
 class OutdatedSinkKind extends string {
   OutdatedSinkKind() {
     this =
@@ -51,6 +52,7 @@ class OutdatedSinkKind extends string {
       ]
   }
 
+  /** Gets a replacement kind for an outdated sink kind. */
   private string replacementKind() {
     this = ["sql", "xpath", "groovy", "jexl", "mvel", "xslt", "ldap", "code", "html"] and
     result = this + "-injection"
@@ -84,6 +86,7 @@ class OutdatedSinkKind extends string {
     this = "uncontrolled-format-string" and result = "format-string"
   }
 
+  /** Gets an error message for an outdated sink kind. */
   string outdatedMessage() {
     result =
       "The kind \"" + this + "\" is outdated. Use \"" + this.replacementKind() + "\" instead."