Commit a1b1d10e authored by rakesh.gectcr's avatar rakesh.gectcr Committed by frjo

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

parent 9cd5a35a
......@@ -10,11 +10,11 @@
*
* Implements hook_colorbox_settings_alter().
*
* @param $settings
* @param array $settings
* An associative array of Colorbox settings. See the
* @link http://colorpowered.com/colorbox/ Colorbox documentation @endlink
* 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
* theme will be loaded.
*/
......
......@@ -115,7 +115,7 @@ function colorbox_page_attachments(array &$page) {
/**
* Check if Colorbox should be active for the current URL.
*
* @return
* @return bool
* TRUE if Colorbox should be active for the current page.
*/
function _colorbox_active() {
......@@ -148,7 +148,9 @@ function _colorbox_active() {
/**
* Converts a text with lines (\n) into an array of lines.
*
* @return
* @param string $text
*
* @return array
* Array with as many items as non-empty lines in the text
*/
function _colorbox_string_to_array($text) {
......@@ -159,7 +161,9 @@ function _colorbox_string_to_array($text) {
/**
* Converts an array of lines into an text with lines (\n).
*
* @return
* @param array $array
*
* @return string
* Text with lines
*/
function _colorbox_array_to_string($array) {
......
......@@ -23,7 +23,7 @@ define('COLORBOX_DOWNLOAD_PREFIX', 'colorbox-');
*
* See `drush topic docs-commands` for a list of recognized keys.
*
* @return
* @return array
* An associative array describing your command(s).
*/
function colorbox_drush_command() {
......@@ -49,10 +49,10 @@ function colorbox_drush_command() {
* This function is called whenever a drush user calls
* 'drush help <name-of-your-command>'
*
* @param
* @param string $section
* A string with the help section (prepend with 'drush:')
*
* @return
* @return string
* A string with the help text for your command.
*/
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