Improve comments

fillpdf.deprecated.inc

@@ -27,7 +27,7 @@
  *
  * @throws Exception
  *
- * @deprecated in 7.x-1.10 and will be removed from all future branches. Use
+ * @deprecated in fillpdf:7.x-1.10 and is removed from all future branches. Use
  * fillpdf_merge_execute_pdf_action().
  * @see https://www.drupal.org/project/fillpdf/issues/2538428
  */
@@ -99,7 +99,7 @@ function fillpdf_merge_handle_pdf($pdf_info, $pdf_data, $token_objects, $action
  *
  * @throws \Exception
  *
- * @deprecated in 7.x-1.10 and will be removed from all future branches. Use
+ * @deprecated in fillpdf:7.x-1.10 and is removed from all future branches. Use
  * fillpdf_action_save_to_file().
  * @see https://www.drupal.org/project/fillpdf/issues/2538428
  */
@@ -158,6 +158,10 @@ function fillpdf_save_to_file($pdf_info, $pdf_data, $token_objects, $output_name
 
 /**
  * Stores the updated $field in the database.
+ *
+ * @deprecated in fillpdf:7.x-1.11 and is removed from all future branches. Use
+ * fillpdf_fields_create_update().
+ * @see https://www.drupal.org/project/fillpdf/issues/2332323
  */
 function fillpdf_update_field($pdf_form, $field, $old_key) {
   $field = (array) $field;

fillpdf.module

@@ -792,6 +792,8 @@ function fillpdf_merge_pdf($fid, $nids = NULL, $webform_array = NULL, $sample =
 }
 
 /**
+ * Load entities needed to fill PDFs.
+ *
  * @param $fillpdf_info
  * @param $nids
  * @param $webform_array
@@ -801,6 +803,7 @@ function fillpdf_merge_pdf($fid, $nids = NULL, $webform_array = NULL, $sample =
  * @param $entity_ids
  *
  * @return array
+ *   An array of entities.
  */
 function fillpdf_load_entities($fillpdf_info, $nids, $webform_array, $uc_order_ids, $uc_order_product_ids, $user, $entity_ids) {
   $context = array(
@@ -927,6 +930,8 @@ function fillpdf_load_entities($fillpdf_info, $nids, $webform_array, $uc_order_i
 }
 
 /**
+ * Process image tokens.
+ *
  * @param $entity_type
  * @param $entity
  * @param $obj
@@ -964,6 +969,8 @@ function _fillpdf_process_image_tokens($entity_type, $entity, $obj, &$fields, &$
 }
 
 /**
+ * Prepare image data.
+ *
  * @param $image_path
  * @param $obj
  * @param $fields
@@ -991,6 +998,8 @@ function _fillpdf_prepare_image_data($image_path, $obj, &$fields, &$image_data,
 }
 
 /**
+ * Replace tokens.
+ *
  * @param $value
  * @param $token_objects
  * @param $existing_token
@@ -1009,6 +1018,8 @@ function _fillpdf_merge_pdf_token_replace($value, $token_objects, &$existing_tok
 }
 
 /**
+ * Return a FillPDF options object.
+ *
  * @param $force_download
  * @param $flatten
  * @param $fillpdf_info
@@ -1022,6 +1033,7 @@ function _fillpdf_merge_pdf_token_replace($value, $token_objects, &$existing_tok
  * @param $entities
  *
  * @return object
+ *   The FillPDF options object.
  */
 function _fillpdf_build_options_object($force_download, $flatten, $fillpdf_info, $data, $nodes, $webforms, $uc_orders, $uc_order_products, $token_objects, $sample, $entities) {
   // @todo: Convert function parameters to use $options
@@ -1122,6 +1134,8 @@ function fillpdf_merge_perform_pdf_action($fillpdf_object, $action = 'download',
 }
 
 /**
+ * Save a PDF to a file.
+ *
  * @param object $fillpdf_object
  * @param string $output_name
  * @param bool $redirect
@@ -1352,6 +1366,7 @@ function fillpdf_build_filename($original, $token_objects) {
  *   $fillpdf directly. Possible values: url, stream.
  *
  * @return bool|null|string
+ *   The output of the fill method or FALSE on failure.
  */
 function fillpdf_execute_merge($method, array $fields, $fillpdf, $mode = 'url', $flatten = TRUE, $image_data = array()) {
   $data = NULL;