Swift: Improve QLDoc.

geoffw0 · geoffw0 · commit a7038017dabf · 2023-04-05T11:08:27.000+01:00
diff --git a/swift/ql/lib/codeql/swift/security/InsufficientHashIterationsQuery.qll b/swift/ql/lib/codeql/swift/security/InsufficientHashIterationsQuery.qll
@@ -21,7 +21,7 @@ private class IntLiteralSource extends IterationsSource instanceof IntegerLitera
 }
 
 /**
- * A dataflow configuration from the hash iterations source to expressions that use
+ * A taint tracking configuration from the hash iterations source to expressions that use
  * it to initialize hash functions.
  */
 module InsufficientHashIterationsConfig implements DataFlow::ConfigSig {
diff --git a/swift/ql/lib/codeql/swift/security/WeakSensitiveDataHashingQuery.qll b/swift/ql/lib/codeql/swift/security/WeakSensitiveDataHashingQuery.qll
@@ -9,6 +9,10 @@ import codeql.swift.dataflow.DataFlow
 import codeql.swift.dataflow.TaintTracking
 import codeql.swift.security.WeakSensitiveDataHashingExtensions
 
+/**
+ * A taint tracking configuration from sensitive expressions to broken or weak
+ * hashing sinks.
+ */
 module WeakHashingConfig implements DataFlow::ConfigSig {
   predicate isSource(DataFlow::Node node) { node.asExpr() instanceof SensitiveExpr }
 

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ private class IntLiteralSource extends IterationsSource instanceof IntegerLitera`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`/**`
`24`		`- * A dataflow configuration from the hash iterations source to expressions that use`
	`24`	`+ * A taint tracking configuration from the hash iterations source to expressions that use`
`25`	`25`	`* it to initialize hash functions.`
`26`	`26`	`*/`
`27`	`27`	`module InsufficientHashIterationsConfig implements DataFlow::ConfigSig {`