From dab1d11f5ae3c158c2a653ecf5b829e00551874e Mon Sep 17 00:00:00 2001
From: Liam Morland <lkmorlan@uwaterloo.ca>
Date: Thu, 13 Jun 2019 14:53:56 -0400
Subject: [PATCH] Issue #3036845: Improve comments
---
fillpdf.module | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/fillpdf.module b/fillpdf.module
index 428ba01..2348ce5 100644
--- a/fillpdf.module
+++ b/fillpdf.module
@@ -525,7 +525,7 @@ function fillpdf_context_to_link($fid, $context, $sample = FALSE) {
* Array of IDs of entities from which to draw data. IDs may be integers or
* strings depending on the entity type.
*
- * @return object
+ * @return object|null
* When $handle is FALSE, this function returns the variable it would have
* used to invoke hook_fillpdf_merge_pre_handle(). When $handle is TRUE, it
* returns nothing.
@@ -1075,6 +1075,9 @@ function _fillpdf_build_options_object($force_download, $flatten, $fillpdf_info,
* to the user's browser.
*
* Here, specifically, it's for generating the filename of the handled PDF.
+ *
+ * @return null
+ * Normally, this calls drupal_exit(). In error conditions, it returns NULL.
*/
function fillpdf_merge_perform_pdf_action($fillpdf_object, $action = 'download', $force_download = FALSE) {
$pdf_info = $fillpdf_object->info;
--
GitLab