Skip to content
Snippets Groups Projects
Commit 95b41ab0 authored by Liam Morland's avatar Liam Morland
Browse files

Improve comments

parent 761b0ce7
No related branches found
No related tags found
No related merge requests found
......@@ -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(
......
......@@ -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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment