diff --git a/admin/islandora.admin.inc b/admin/islandora.admin.inc index 49de312c..e3aeb60c 100644 --- a/admin/islandora.admin.inc +++ b/admin/islandora.admin.inc @@ -7,6 +7,7 @@ /** * Create admin form + * * @return array */ function islandora_repository_admin($form, &$form_state) { diff --git a/includes/breadcrumb.inc b/includes/breadcrumb.inc index d1cacdbe..5e553277 100644 --- a/includes/breadcrumb.inc +++ b/includes/breadcrumb.inc @@ -5,6 +5,9 @@ * This file contains functions to create breadcrumbs on Islandora object pages. */ +/** + * Callback function to get the breadcrumbs for an object page + */ function islandora_get_breadcrumbs($object) { $breadcrumbs = array(); diff --git a/includes/datastream.inc b/includes/datastream.inc index fea8747c..42edbd2d 100644 --- a/includes/datastream.inc +++ b/includes/datastream.inc @@ -6,6 +6,7 @@ */ define('DS_COMP_STREAM', 'DS-COMPOSITE-MODEL'); + /** * Callback function to view or download a datastream. * @@ -33,6 +34,9 @@ function islandora_view_datastream($object, $dsid, $method = 'view') { exit(); } +/** + * For a given object, return all parent collections. + */ function islandora_datastream_get_parents($islandora_object) { $parent_collections = array(); @@ -462,7 +466,7 @@ function islandora_edit_datastream($object, $ds_id) { } } -//@TODO: theme / preprocess +// @TODO: theme / preprocess function islandora_edit_datastream_registry_render($edit_registry) { $output = array( '#type' => 'markup', diff --git a/includes/ingest-menu.inc b/includes/ingest-menu.inc index 56ae500e..5e7d9436 100644 --- a/includes/ingest-menu.inc +++ b/includes/ingest-menu.inc @@ -7,6 +7,7 @@ /** * Callback function for islandora/ingest/%collection_pid + * * @TODO: validate?: pid, registry return * @param string $pid */ diff --git a/includes/utilities.inc b/includes/utilities.inc index d4cb0b40..49eb98e6 100644 --- a/includes/utilities.inc +++ b/includes/utilities.inc @@ -37,6 +37,9 @@ function islandora_convert_bytes_to_human_readable($bytes, $precision = 2) { } } +/** + * Creates a label for control group symbols. + */ function islandora_control_group_to_human_readable($control_group) { switch ($control_group) { case 'M': diff --git a/islandora.module b/islandora.module index 17171ff8..4a0fbd6a 100644 --- a/islandora.module +++ b/islandora.module @@ -201,6 +201,9 @@ function islandora_menu() { return $items; } +/** + * Implements hook_admin_paths(). + */ function islandora_admin_paths() { $paths = array(); $paths['islandora/object/*/manage*'] = TRUE; @@ -348,8 +351,9 @@ function islandora_view_object($fedora_object = NULL) { } /** - * the default view hook. If there are no modules registered to handle this objects cmodels or there are + * The default view hook. If there are no modules registered to handle this objects cmodels or there are * not any cmodels specified this will create a default display. + * * @param string $object_id * @return string */ @@ -366,7 +370,8 @@ function islandora_islandora_view_object($object) { } /** - * Theme registry function + * Implements hook_theme(). + * * @return array */ function islandora_theme() { @@ -385,7 +390,8 @@ function islandora_theme() { } /** - * drupal hook_permissions function + * Implements hook_permission(). + * * @return array */ function islandora_permission() { @@ -422,7 +428,8 @@ function islandora_permission() { } /** - * a helper function to get a connection and return an object + * A helper function to get a connection and return an object + * * @global object $user * @param string $object_id * @return FedoraObject @@ -449,6 +456,9 @@ function islandora_object_load($object_id) { } } +/** + * Ingest access callback + */ function islandora_ingest_access_callback($object, $perm) { if (islandora_access_callback($object, $perm) === FALSE) { return FALSE; diff --git a/theme/islandora.theme.inc b/theme/islandora.theme.inc index b0e79739..7999e0d0 100644 --- a/theme/islandora.theme.inc +++ b/theme/islandora.theme.inc @@ -6,7 +6,8 @@ */ /** - * preprocess the edit template + * Preprocess the edit template + * * @global string $base_url * @param array $variables * theme variables for the edit template @@ -49,7 +50,8 @@ function islandora_preprocess_islandora_default_edit(&$variables) { /** - * preprocess for the default view template + * Preprocess for the default view template + * * @global string $base_url * @param array $variables */