C++: Update doc for `getMinimumKeySize

rdmarsh2 · geoffw0 · web-flow · commit cfd9c9d137d4 · 2022-02-16T14:53:09.000-05:00
Co-authored-by: Geoffrey White &lt;40627776+geoffw0@users.noreply.github.com&gt;
diff --git a/cpp/ql/src/Security/CWE/CWE-326/InsufficientKeySize.ql b/cpp/ql/src/Security/CWE/CWE-326/InsufficientKeySize.ql
@@ -14,7 +14,7 @@ import cpp
 import semmle.code.cpp.ir.dataflow.DataFlow
 import semmle.code.cpp.ir.IR
 
-// Holds if `func` is the name of an encryption function that accepts a key size as parameter `paramIndex`
+// Gets the recommended minimum key size (in bits) of `func`, the name of an encryption function that accepts a key size as parameter `paramIndex`
 int getMinimumKeyStrength(string func, int paramIndex) {
   func =
     [

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ import cpp`
`14`	`14`	`import semmle.code.cpp.ir.dataflow.DataFlow`
`15`	`15`	`import semmle.code.cpp.ir.IR`
`16`	`16`
`17`		-// Holds if `func` is the name of an encryption function that accepts a key size as parameter `paramIndex`
	`17`	+// Gets the recommended minimum key size (in bits) of `func`, the name of an encryption function that accepts a key size as parameter `paramIndex`
`18`	`18`	`int getMinimumKeyStrength(string func, int paramIndex) {`
`19`	`19`	`func =`
`20`	`20`	`[`