Commit 532ee439 authored by rakesh.gectcr's avatar rakesh.gectcr Committed by frjo
Browse files

Issue #2616140 by rakesh.gectcr: Add @return type and @param values in the comment docblocks

parent 3f72f007
...@@ -10,11 +10,11 @@ ...@@ -10,11 +10,11 @@
* *
* Implements hook_colorbox_settings_alter(). * Implements hook_colorbox_settings_alter().
* *
* @param $settings * @param array $settings
* An associative array of Colorbox settings. See the * An associative array of Colorbox settings. See the
* @link http://colorpowered.com/colorbox/ Colorbox documentation @endlink * @link http://colorpowered.com/colorbox/ Colorbox documentation @endlink
* for the full list of supported parameters. * for the full list of supported parameters.
* @param $style * @param string $style
* The name of the active style plugin. If $style is 'none', no Colorbox * The name of the active style plugin. If $style is 'none', no Colorbox
* theme will be loaded. * theme will be loaded.
*/ */
...@@ -31,7 +31,7 @@ function hook_colorbox_settings_alter(&$settings, &$style) { ...@@ -31,7 +31,7 @@ function hook_colorbox_settings_alter(&$settings, &$style) {
/** /**
* Allows to override activation of Colorbox for the current URL. * Allows to override activation of Colorbox for the current URL.
* *
* @param $active * @param bool $active
* A boolean indicating whether colorbox should be active for the current * A boolean indicating whether colorbox should be active for the current
* URL or not. * URL or not.
*/ */
......
...@@ -132,7 +132,7 @@ function colorbox_menu() { ...@@ -132,7 +132,7 @@ function colorbox_menu() {
/** /**
* Check if Colorbox should be active for the current URL. * Check if Colorbox should be active for the current URL.
* *
* @return * @return bool
* TRUE if Colorbox should be active for the current page. * TRUE if Colorbox should be active for the current page.
*/ */
function _colorbox_active() { function _colorbox_active() {
...@@ -492,6 +492,8 @@ function colorbox_field_formatter_view($entity_type, $entity, $field, $instance, ...@@ -492,6 +492,8 @@ function colorbox_field_formatter_view($entity_type, $entity, $field, $instance,
/** /**
* Implements hook_insert_styles(). * Implements hook_insert_styles().
*
* @return array
*/ */
function colorbox_insert_styles() { function colorbox_insert_styles() {
$insert_styles = array(); $insert_styles = array();
...@@ -514,7 +516,7 @@ function colorbox_insert_content($item, $style, $widget) { ...@@ -514,7 +516,7 @@ function colorbox_insert_content($item, $style, $widget) {
/** /**
* Machine names normally need to be unique but that does not apply to galleries. * Machine names normally need to be unique but that does not apply to galleries.
* *
* @return * @return false
* Always FALSE * Always FALSE
*/ */
function colorbox_gallery_exists() { function colorbox_gallery_exists() {
......
...@@ -8,12 +8,15 @@ ...@@ -8,12 +8,15 @@
/** /**
* Returns HTML for an Colorbox image field formatter. * Returns HTML for an Colorbox image field formatter.
* *
* @param $variables * @param array $variables
* An associative array containing: * An associative array containing:
* - item: An array of image data. * - item: An array of image data.
* - image_style: An optional image style. * - image_style: An optional image style.
* - path: An array containing the link 'path' and link 'options'. * - path: An array containing the link 'path' and link 'options'.
* *
* @return string
* An HTML string representing the themed output.
*
* @ingroup themeable * @ingroup themeable
*/ */
function theme_colorbox_image_formatter($variables) { function theme_colorbox_image_formatter($variables) {
...@@ -147,13 +150,16 @@ function theme_colorbox_image_formatter($variables) { ...@@ -147,13 +150,16 @@ function theme_colorbox_image_formatter($variables) {
/** /**
* Returns HTML for an image using a specific Colorbox image style. * Returns HTML for an image using a specific Colorbox image style.
* *
* @param $variables * @param array $variables
* An associative array containing: * An associative array containing:
* - image: image item as array. * - image: image item as array.
* - path: The path of the image that should be displayed in the Colorbox. * - path: The path of the image that should be displayed in the Colorbox.
* - title: The title text that will be used as a caption in the Colorbox. * - title: The title text that will be used as a caption in the Colorbox.
* - gid: Gallery id for Colorbox image grouping. * - gid: Gallery id for Colorbox image grouping.
* *
* @return string
* An HTML string containing a link to the given path.
*
* @ingroup themeable * @ingroup themeable
*/ */
function theme_colorbox_imagefield($variables) { function theme_colorbox_imagefield($variables) {
...@@ -186,6 +192,8 @@ function theme_colorbox_imagefield($variables) { ...@@ -186,6 +192,8 @@ function theme_colorbox_imagefield($variables) {
/** /**
* Preprocess variables for the colorbox-insert-image.tpl.php file. * Preprocess variables for the colorbox-insert-image.tpl.php file.
*
* @param array $variables
*/ */
function template_preprocess_colorbox_insert_image(&$variables) { function template_preprocess_colorbox_insert_image(&$variables) {
$item = $variables['item']; $item = $variables['item'];
......
...@@ -23,7 +23,7 @@ define('COLORBOX_DOWNLOAD_PREFIX', 'colorbox-'); ...@@ -23,7 +23,7 @@ define('COLORBOX_DOWNLOAD_PREFIX', 'colorbox-');
* *
* See `drush topic docs-commands` for a list of recognized keys. * See `drush topic docs-commands` for a list of recognized keys.
* *
* @return * @return array
* An associative array describing your command(s). * An associative array describing your command(s).
*/ */
function colorbox_drush_command() { function colorbox_drush_command() {
...@@ -49,10 +49,10 @@ function colorbox_drush_command() { ...@@ -49,10 +49,10 @@ function colorbox_drush_command() {
* This function is called whenever a drush user calls * This function is called whenever a drush user calls
* 'drush help <name-of-your-command>' * 'drush help <name-of-your-command>'
* *
* @param * @param string $section
* A string with the help section (prepend with 'drush:') * A string with the help section (prepend with 'drush:')
* *
* @return * @return string
* A string with the help text for your command. * A string with the help text for your command.
*/ */
function colorbox_drush_help($section) { function colorbox_drush_help($section) {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment