From 27337f7d40170aab5ecab6789510109a0b77626c Mon Sep 17 00:00:00 2001
From: Liam Morland <lkmorlan@uwaterloo.ca>
Date: Thu, 13 Jun 2019 15:15:11 -0400
Subject: [PATCH] Issue #1866174: Improve comments

---
 fillpdf.module | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/fillpdf.module b/fillpdf.module
index e696596..fa0b62d 100644
--- a/fillpdf.module
+++ b/fillpdf.module
@@ -2009,7 +2009,13 @@ function fillpdf_load($fid, $reset = FALSE, $process_replacements = TRUE) {
 }
 
 /**
+ * Test whether the pdftk path is valid.
  *
+ * @param string $pdftk_path
+ *   The path to test.
+ *
+ * @return bool
+ *   TRUE if the path is the pdftk binary, FALSE otherwise.
  */
 function fillpdf_pdftk_check($pdftk_path = 'pdftk') {
   // An empty value means we should leave it to the PATH.
@@ -2019,6 +2025,7 @@ function fillpdf_pdftk_check($pdftk_path = 'pdftk') {
   $output = array();
   $status = NULL;
   exec($pdftk_path, $output, $status);
+  // Check the exit status.
   if (in_array($status, array(126, 127))) {
     return FALSE;
   }
-- 
GitLab