@@ -37,6 +37,7 @@ discard block |
||
37 | 37 | * |
38 | 38 | * @return |
39 | 39 | * The cached content, or FALSE to indicate no cached content exists. |
40 | + * @param stdClass $pane |
|
40 | 41 | */ |
41 | 42 | function panels_get_cached_content($display, $args, $context, $pane = NULL) { |
42 | 43 | // Never use cache on a POST |
@@ -64,6 +65,7 @@ discard block |
||
64 | 65 | |
65 | 66 | /** |
66 | 67 | * Store cached content for a given display and possibly pane. |
68 | + * @param stdClass $pane |
|
67 | 69 | */ |
68 | 70 | function panels_set_cached_content($cache, $display, $args, $context, $pane = NULL) { |
69 | 71 | // Never use cache on a POST |
@@ -505,12 +507,12 @@ discard block |
||
505 | 507 | /** |
506 | 508 | * Get a function from a plugin, if it exists. |
507 | 509 | * |
508 | - * @param $plugin |
|
510 | + * @param string $plugin |
|
509 | 511 | * The type of plugin |
510 | 512 | * @param $which |
511 | 513 | * Either the loaded plugin object (or the same data in array form) |
512 | 514 | * or a string with the name of the desired the specific plugin. |
513 | - * @param $function_name |
|
515 | + * @param string $function_name |
|
514 | 516 | * The identifier of the function. For example, 'settings form'. |
515 | 517 | * |
516 | 518 | * @return |
@@ -15,7 +15,7 @@ discard block |
||
15 | 15 | /** |
16 | 16 | * Returns the API version of Panels. This didn't exist in 1. |
17 | 17 | * |
18 | - * @return An array with the major and minor versions |
|
18 | + * @return integer[] array with the major and minor versions |
|
19 | 19 | */ |
20 | 20 | function panels_api_version() { |
21 | 21 | return array(3, 1); |
@@ -550,7 +550,7 @@ discard block |
||
550 | 550 | * @param mixed $destination |
551 | 551 | * Basic usage is a string containing the URL that the form should redirect to upon submission. |
552 | 552 | * For a discussion of advanced usages, see panels_edit(). |
553 | - * @param mixed $allowed_layouts |
|
553 | + * @param string $allowed_layouts |
|
554 | 554 | * Allowed layouts has three different behaviors that depend on which of three value types |
555 | 555 | * are passed in by the caller: |
556 | 556 | * #- if $allowed_layouts instanceof panels_allowed_layouts (includes subclasses): the most |
@@ -1130,6 +1130,7 @@ discard block |
||
1130 | 1130 | /** |
1131 | 1131 | * Print the layout link. Sends out to a theme function. |
1132 | 1132 | * @layout |
1133 | + * @param string $link |
|
1133 | 1134 | */ |
1134 | 1135 | function panels_print_layout_link($id, $layout, $link, $options = array()) { |
1135 | 1136 | if (isset($options['query']['q'])) { |
@@ -1311,6 +1312,7 @@ discard block |
||
1311 | 1312 | |
1312 | 1313 | /** |
1313 | 1314 | * Get an object from cache. |
1315 | + * @param string $obj |
|
1314 | 1316 | */ |
1315 | 1317 | function panels_cache_get($obj, $did, $skip_cache = FALSE) { |
1316 | 1318 | ctools_include('object-cache'); |
@@ -1322,6 +1324,7 @@ discard block |
||
1322 | 1324 | |
1323 | 1325 | /** |
1324 | 1326 | * Save the edited object into the cache. |
1327 | + * @param string $obj |
|
1325 | 1328 | */ |
1326 | 1329 | function panels_cache_set($obj, $did, $cache) { |
1327 | 1330 | ctools_include('object-cache'); |
@@ -1330,6 +1333,7 @@ discard block |
||
1330 | 1333 | |
1331 | 1334 | /** |
1332 | 1335 | * Clear a object from the cache; used if the editing is aborted. |
1336 | + * @param string $obj |
|
1333 | 1337 | */ |
1334 | 1338 | function panels_cache_clear($obj, $did) { |
1335 | 1339 | ctools_include('object-cache'); |
@@ -8,10 +8,8 @@ |
||
8 | 8 | /** |
9 | 9 | * Allow modules to control access to the Panels IPE. |
10 | 10 | * |
11 | - * @param panels_display $display |
|
12 | - * The panels display about to be rendered. |
|
13 | 11 | * |
14 | - * @return TRUE|FALSE|NULL |
|
12 | + * @return null|boolean |
|
15 | 13 | * Returns TRUE to allow access, FALSE to deny, or NULL if the module |
16 | 14 | * implementing this hook doesn't care about access for the given display. |
17 | 15 | */ |
@@ -127,7 +127,7 @@ |
||
127 | 127 | * |
128 | 128 | * Adds the IPE control container. |
129 | 129 | * |
130 | - * @param unknown_type $main |
|
130 | + * @param integer $main |
|
131 | 131 | */ |
132 | 132 | function panels_ipe_footer($main = 0) { |
133 | 133 | $key = panels_ipe_get_cache_key(); |
@@ -165,6 +165,7 @@ discard block |
||
165 | 165 | * Get the style links. |
166 | 166 | * |
167 | 167 | * This is abstracted out since we have styles on both panes and regions. |
168 | + * @param string $type |
|
168 | 169 | */ |
169 | 170 | function get_style_links($type, $id = NULL) { |
170 | 171 | $info = $this->get_style($type, $id); |
@@ -534,6 +535,7 @@ discard block |
||
534 | 535 | |
535 | 536 | /** |
536 | 537 | * AJAX command to present a dialog with a list of available content. |
538 | + * @param string $category |
|
537 | 539 | */ |
538 | 540 | function ajax_select_content($region = NULL, $category = NULL) { |
539 | 541 | if (!array_key_exists($region, $this->plugins['layout']['panels'])) { |
@@ -932,7 +934,7 @@ discard block |
||
932 | 934 | /** |
933 | 935 | * AJAX entry point to configure the cache settings for a pane or the display. |
934 | 936 | * |
935 | - * @param string $pid |
|
937 | + * @param integer $pid |
|
936 | 938 | * Either a pane id for a pane in the display, or 'display' to edit the |
937 | 939 | * display cache settings. |
938 | 940 | */ |
@@ -1344,6 +1346,7 @@ discard block |
||
1344 | 1346 | |
1345 | 1347 | /** |
1346 | 1348 | * AJAX entry point for to configure vsibility rule. |
1349 | + * @param string $id |
|
1347 | 1350 | */ |
1348 | 1351 | function ajax_access_configure_test($pid = NULL, $id = NULL) { |
1349 | 1352 | if (empty($this->display->content[$pid])) { |
@@ -430,6 +430,7 @@ |
||
430 | 430 | * The arguments should exactly match drupal_add_css(). |
431 | 431 | * |
432 | 432 | * @see drupal_add_css |
433 | + * @param string $filename |
|
433 | 434 | */ |
434 | 435 | function add_css($filename, $type = 'module', $media = 'all', $preprocess = TRUE) { |
435 | 436 | $path = file_create_path($filename); |
@@ -270,6 +270,7 @@ discard block |
||
270 | 270 | * to function allowing us to render our CSS and HTML easily. |
271 | 271 | * |
272 | 272 | * @todo Convert the functions to methods and make this properly OO. |
273 | + * @param boolean $admin |
|
273 | 274 | */ |
274 | 275 | function panels_flexible_create_renderer($admin, $id, $content, $settings, &$display, $layout, $handler) { |
275 | 276 | $renderer = new stdClass; |
@@ -435,6 +436,7 @@ discard block |
||
435 | 436 | |
436 | 437 | /** |
437 | 438 | * Render a piece of a flexible layout. |
439 | + * @param stdClass $renderer |
|
438 | 440 | */ |
439 | 441 | function panels_flexible_render_items($renderer, $list, $owner_id) { |
440 | 442 | $output = ''; |
@@ -493,6 +495,7 @@ discard block |
||
493 | 495 | |
494 | 496 | /** |
495 | 497 | * Render a column in the flexible layout. |
498 | + * @param integer $max |
|
496 | 499 | */ |
497 | 500 | function panels_flexible_render_item($renderer, $item, $content, $id, $position, $max, $clear = FALSE) { |
498 | 501 | |
@@ -707,6 +710,7 @@ discard block |
||
707 | 710 | } |
708 | 711 | /** |
709 | 712 | * Provide CSS for a flexible layout. |
713 | + * @param stdClass $renderer |
|
710 | 714 | */ |
711 | 715 | function panels_flexible_render_css($renderer) { |
712 | 716 | if ($renderer->admin) { |
@@ -724,6 +728,9 @@ discard block |
||
724 | 728 | * Columns and regions, when displayed as a group, need to cooperate in |
725 | 729 | * order to share margins and make sure that percent widths add up |
726 | 730 | * to the right total. |
731 | + * @param string $owner_id |
|
732 | + * @param string $type |
|
733 | + * @param string $id |
|
727 | 734 | */ |
728 | 735 | function panels_flexible_render_css_group($renderer, $list, $owner_id, $type, $id) { |
729 | 736 | $css = array(); |
@@ -202,6 +202,11 @@ |
||
202 | 202 | return $value; |
203 | 203 | } |
204 | 204 | |
205 | + /** |
|
206 | + * @param string $option |
|
207 | + * |
|
208 | + * @return string |
|
209 | + */ |
|
205 | 210 | function case_transform($string, $option) { |
206 | 211 | global $multibyte; |
207 | 212 |
@@ -566,6 +566,7 @@ |
||
566 | 566 | |
567 | 567 | /** |
568 | 568 | * Trim the field down to the specified length. |
569 | + * @param string $value |
|
569 | 570 | */ |
570 | 571 | function render_trim_text($alter, $value) { |
571 | 572 | if (!empty($alter['strip_tags'])) { |