From 95b41ab01d7e830def8b31716c913ac41168bbcb Mon Sep 17 00:00:00 2001
From: Liam Morland <lkmorlan@uwaterloo.ca>
Date: Thu, 30 May 2019 16:13:50 -0400
Subject: [PATCH] Improve comments
---
fillpdf.admin.inc | 2 +-
fillpdf.module | 13 +++++++++++--
2 files changed, 12 insertions(+), 3 deletions(-)
diff --git a/fillpdf.admin.inc b/fillpdf.admin.inc
index abcea42..0342d2c 100644
--- a/fillpdf.admin.inc
+++ b/fillpdf.admin.inc
@@ -114,7 +114,7 @@ function fillpdf_settings($form, &$form_state) {
* Suitable for use with FAPI radio buttons.
*
* @return array
- * Array of acceptable file scheme options as identifyer => translated title.
+ * Array of acceptable file scheme options as identifier => translated title.
*/
function _fillpdf_scheme_options() {
return array(
diff --git a/fillpdf.module b/fillpdf.module
index 6f8cc16..c86da1e 100644
--- a/fillpdf.module
+++ b/fillpdf.module
@@ -331,9 +331,13 @@ function fillpdf_parse_uri($uri = NULL) {
}
/**
- * @param $uri
+ * Parse a URI into context.
+ *
+ * @param string $uri
+ * The URI to parse.
*
* @return array
+ * The context.
*/
function fillpdf_link_to_stub_context($uri) {
$parsed_url = drupal_parse_url($uri);
@@ -1637,7 +1641,8 @@ function fillpdf_fields_create_update($fid, $pdf_key, array &$record, $update =
* using a PDF on the file system and Stream mode merges using the value of
* $fillpdf directly. Possible values: url, stream.
*
- * @return array
+ * @return array|false
+ * The parsed fields.
*/
function fillpdf_execute_parse($method, $fillpdf, $mode = 'url') {
switch ($mode) {
@@ -2070,6 +2075,7 @@ function fillpdf_file_usage_add($file, $fillpdf_object) {
* references. You will have to clean up {fillpdf_file_context} yourself.
*
* @param object $file
+ * The file object.
*
* @see file_usage_delete()
*/
@@ -2091,6 +2097,8 @@ function fillpdf_file_usage_delete(stdClass $file) {
}
/**
+ * Load a file context object.
+ *
* @param int $fcid
* The fcid of the context object to load.
*
@@ -2111,6 +2119,7 @@ function fillpdf_file_context_load($fcid) {
* Helper function to find out if FillPDF manages this file.
*
* @param object $file
+ * The file object.
*
* @return array|bool
* The file_usage record if FillPDF manages this file, or FALSE if it doesn't.
--
GitLab