Shared: update qldocs

Jami Cogswell · Jami Cogswell · commit 9d5972acc2a3 · 2023-06-05T12:18:34.000-04:00
diff --git a/csharp/ql/lib/semmle/code/csharp/dataflow/ExternalFlow.qll b/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
diff --git a/csharp/ql/lib/semmle/code/csharp/dataflow/SharedModelValidation.qll b/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."
diff --git a/go/ql/lib/semmle/go/dataflow/ExternalFlow.qll b/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
diff --git a/go/ql/lib/semmle/go/dataflow/SharedModelValidation.qll b/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."
diff --git a/java/ql/lib/semmle/code/java/dataflow/ExternalFlow.qll b/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
diff --git a/java/ql/lib/semmle/code/java/dataflow/SharedModelValidation.qll b/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."
diff --git a/javascript/ql/lib/semmle/javascript/frameworks/data/internal/ApiGraphModels.qll b/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
diff --git a/javascript/ql/lib/semmle/javascript/frameworks/data/internal/SharedModelValidation.qll b/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."
diff --git a/python/ql/lib/semmle/python/frameworks/data/internal/ApiGraphModels.qll b/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
diff --git a/python/ql/lib/semmle/python/frameworks/data/internal/SharedModelValidation.qll b/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."
diff --git a/ruby/ql/lib/codeql/ruby/frameworks/data/internal/ApiGraphModels.qll b/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
diff --git a/ruby/ql/lib/codeql/ruby/frameworks/data/internal/SharedModelValidation.qll b/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."
diff --git a/swift/ql/lib/codeql/swift/dataflow/ExternalFlow.qll b/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
diff --git a/swift/ql/lib/codeql/swift/dataflow/SharedModelValidation.qll b/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."

Original file line number	Diff line number	Diff line change
`@@ -205,6 +205,7 @@ module ModelValidation {`
`205`	`205`	`)`
`206`	`206`	`}`
`207`	`207`
	`208`	`+ /** Gets an error message relating to an invalid kind in a model. */`
`208`	`209`	`private string getInvalidModelKind() {`
`209`	`210`	`exists(string kind \| summaryModel(_, _, _, _, _, _, _, _, kind, _) \|`
`210`	`211`	`not kind instanceof ValidSummaryKind and`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`/**`
`2`	`2`	`* INTERNAL: Do not use.`
`3`	`3`	`*`
`4`		`- * Provides classes for validating kinds in models as data rows.`
	`4`	`+ * Provides classes and predicates related to validating models as data rows.`
`5`	`5`	`* Such that we can share this logic across our CodeQL analysis of different languages.`
`6`	`6`	`*/`
`7`	`7`
`@@ -40,6 +40,7 @@ class ValidSinkKind extends string {`
`40`	`40`	`}`
`41`	`41`	`}`
`42`	`42`
	`43`	`+/** An outdated models-as-data sink kind. */`
`43`	`44`	`class OutdatedSinkKind extends string {`
`44`	`45`	`OutdatedSinkKind() {`
`45`	`46`	`this =`
`@@ -51,6 +52,7 @@ class OutdatedSinkKind extends string {`
`51`	`52`	`]`
`52`	`53`	`}`
`53`	`54`
	`55`	`+ /** Gets a replacement kind for an outdated sink kind. */`
`54`	`56`	`private string replacementKind() {`
`55`	`57`	`this = ["sql", "xpath", "groovy", "jexl", "mvel", "xslt", "ldap", "code", "html"] and`
`56`	`58`	`result = this + "-injection"`
`@@ -84,6 +86,7 @@ class OutdatedSinkKind extends string {`
`84`	`86`	`this = "uncontrolled-format-string" and result = "format-string"`
`85`	`87`	`}`
`86`	`88`
	`89`	`+ /** Gets an error message for an outdated sink kind. */`
`87`	`90`	`string outdatedMessage() {`
`88`	`91`	`result =`
`89`	`92`	`"The kind \"" + this + "\" is outdated. Use \"" + this.replacementKind() + "\" instead."`
Original file line number	Diff line number	Diff line change
`@@ -189,6 +189,7 @@ module ModelValidation {`
`189`	`189`	`)`
`190`	`190`	`}`
`191`	`191`
	`192`	`+ /** Gets an error message relating to an invalid kind in a model. */`
`192`	`193`	`private string getInvalidModelKind() {`
`193`	`194`	`exists(string kind \| summaryModel(_, _, _, _, _, _, _, _, kind, _) \|`
`194`	`195`	`not kind instanceof ValidSummaryKind and`
Original file line number	Diff line number	Diff line change
`@@ -266,6 +266,7 @@ module ModelValidation {`
`266`	`266`	`)`
`267`	`267`	`}`
`268`	`268`
	`269`	`+ /** Gets an error message relating to an invalid kind in a model. */`
`269`	`270`	`private string getInvalidModelKind() {`
`270`	`271`	`exists(string kind \| summaryModel(_, _, _, _, _, _, _, _, kind, _) \|`
`271`	`272`	`not kind instanceof ValidSummaryKind and`