From b7730fb1adb38124f33fc2787fd20545930c4620 Mon Sep 17 00:00:00 2001
From: Geoffrey White <40627776+geoffw0@users.noreply.github.com>
Date: Thu, 25 Jun 2020 15:28:27 +0100
Subject: [PATCH] C++: QLDoc PrintfLike.qll.

---
 cpp/ql/src/semmle/code/cpp/security/PrintfLike.qll | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/cpp/ql/src/semmle/code/cpp/security/PrintfLike.qll b/cpp/ql/src/semmle/code/cpp/security/PrintfLike.qll
index 47d0ca3aa93..b43e6cb49f1 100644
--- a/cpp/ql/src/semmle/code/cpp/security/PrintfLike.qll
+++ b/cpp/ql/src/semmle/code/cpp/security/PrintfLike.qll
@@ -1,6 +1,18 @@
+/**
+ * Provides a predicate for identifying formatting functions like `printf`.
+ * 
+ * Consider using the newer model in
+ * `semmle.code.cpp.models.interfaces.FormattingFunction` directly instead of
+ * this library.
+ */
+
 import semmle.code.cpp.commons.Printf
 import external.ExternalArtifact
 
+/**
+ * Holds if `func` is a `printf`-like formatting function and `formatArg` is
+ * the index of the format string argument.
+ */
 predicate printfLikeFunction(Function func, int formatArg) {
   formatArg = func.(FormattingFunction).getFormatParameterIndex() and
   not func instanceof UserDefinedFormattingFunction