@@ -226,6 +226,7 @@ |
||
226 | 226 | * An array of the context requested in this export. |
227 | 227 | * @param $module_name |
228 | 228 | * Optional. The name for the exported module. |
229 | + * @param string $directory |
|
229 | 230 | */ |
230 | 231 | function _drush_features_export($stub, $dependencies, $module_name = NULL, $directory = NULL) { |
231 | 232 | $root = drush_get_option(array('r', 'root'), drush_locate_root()); |
@@ -62,6 +62,7 @@ discard block |
||
62 | 62 | |
63 | 63 | /** |
64 | 64 | * Iterates over data and convert to dependencies if already defined elsewhere. |
65 | + * @param string $module_name |
|
65 | 66 | */ |
66 | 67 | function _features_resolve_dependencies(&$data, &$export, $module_name, $component) { |
67 | 68 | if ($map = features_get_default_map($component)) { |
@@ -371,7 +372,7 @@ discard block |
||
371 | 372 | * Array of parent keys (internal use only). |
372 | 373 | * |
373 | 374 | * @return |
374 | - * A code string ready to be written to a module's .info file. |
|
375 | + string A code string ready to be written to a module's .info file. |
|
375 | 376 | */ |
376 | 377 | function features_export_info($info, $parents = array()) { |
377 | 378 | $output = ''; |
@@ -402,7 +403,7 @@ discard block |
||
402 | 403 | * String contents of the file. |
403 | 404 | * |
404 | 405 | * @return |
405 | - * A string of the tar file contents. |
|
406 | + string A string of the tar file contents. |
|
406 | 407 | */ |
407 | 408 | function features_tar_create($name, $contents) { |
408 | 409 | $tar = ''; |
@@ -551,6 +552,7 @@ discard block |
||
551 | 552 | |
552 | 553 | /** |
553 | 554 | * Processing semaphore operations. |
555 | + * @param string $op |
|
554 | 556 | */ |
555 | 557 | function features_semaphore($op, $component) { |
556 | 558 | // Note: we don't use variable_get() here as the inited variable |
@@ -675,6 +677,8 @@ discard block |
||
675 | 677 | |
676 | 678 | /** |
677 | 679 | * Get a map of components to their providing modules. |
680 | + * @param string $attribute |
|
681 | + * @param string $callback |
|
678 | 682 | */ |
679 | 683 | function features_get_default_map($component, $attribute = NULL, $callback = NULL, $reset = FALSE) { |
680 | 684 | static $map = array(); |
@@ -395,6 +395,7 @@ discard block |
||
395 | 395 | |
396 | 396 | /** |
397 | 397 | * Invoke a component callback. |
398 | + * @param string $callback |
|
398 | 399 | */ |
399 | 400 | function features_invoke($component, $callback) { |
400 | 401 | $args = func_get_args(); |
@@ -410,7 +411,7 @@ discard block |
||
410 | 411 | * Checks whether a component implements the given hook. |
411 | 412 | * |
412 | 413 | * @return |
413 | - * The function implementing the hook, or FALSE. |
|
414 | + string|false The function implementing the hook, or FALSE. |
|
414 | 415 | */ |
415 | 416 | function features_hook($component, $hook, $reset = FALSE) { |
416 | 417 | static $info; |
@@ -665,6 +666,7 @@ discard block |
||
665 | 666 | |
666 | 667 | /** |
667 | 668 | * Restore the specified modules to the default state. |
669 | + * @param string $op |
|
668 | 670 | */ |
669 | 671 | function _features_restore($op, $items = array()) { |
670 | 672 | // Since we can't ensure that users will run update.php immediately after |
@@ -88,6 +88,7 @@ discard block |
||
88 | 88 | * |
89 | 89 | * Note that this master hook does not use $component like the others, but uses the |
90 | 90 | * component module's namespace instead. |
91 | + * @param string $module_name |
|
91 | 92 | */ |
92 | 93 | function ctools_component_features_api($module_name) { |
93 | 94 | $api = array(); |
@@ -101,6 +102,7 @@ discard block |
||
101 | 102 | |
102 | 103 | /** |
103 | 104 | * Master implementation of hook_features_export_options() for all ctools components. |
105 | + * @param string $component |
|
104 | 106 | */ |
105 | 107 | function ctools_component_features_export_options($component) { |
106 | 108 | $options = array(); |
@@ -121,6 +123,7 @@ discard block |
||
121 | 123 | |
122 | 124 | /** |
123 | 125 | * Master implementation of hook_features_export() for all ctools components. |
126 | + * @param string $component |
|
124 | 127 | */ |
125 | 128 | function ctools_component_features_export($component, $data, &$export, $module_name = '') { |
126 | 129 | // Add the actual implementing module as a dependency |
@@ -153,6 +156,7 @@ discard block |
||
153 | 156 | |
154 | 157 | /** |
155 | 158 | * Master implementation of hook_features_export_render() for all ctools components. |
159 | + * @param string $component |
|
156 | 160 | */ |
157 | 161 | function ctools_component_features_export_render($component, $module, $data) { |
158 | 162 | ctools_include('export'); |
@@ -183,6 +187,7 @@ discard block |
||
183 | 187 | |
184 | 188 | /** |
185 | 189 | * Master implementation of hook_features_revert() for all ctools components. |
190 | + * @param string $component |
|
186 | 191 | */ |
187 | 192 | function ctools_component_features_revert($component, $module) { |
188 | 193 | if ($objects = features_get_default($component, $module)) { |
@@ -172,6 +172,9 @@ |
||
172 | 172 | return $menu_links; |
173 | 173 | } |
174 | 174 | |
175 | +/** |
|
176 | + * @param string $indent |
|
177 | + */ |
|
175 | 178 | function _menu_links_features_export_options_recurse($tree, $menu_name, $indent, &$menu_links) { |
176 | 179 | // We don't want to use _menu_parents_recurse as that could potentially cut out some |
177 | 180 | // options as not being suitable for parents which we still want to export. Also we can |
@@ -339,6 +339,7 @@ discard block |
||
339 | 339 | |
340 | 340 | /** |
341 | 341 | * Based upon the settings, get the allowed types for this node. |
342 | + * @param string $module |
|
342 | 343 | */ |
343 | 344 | function panels_common_get_allowed_types($module, $contexts = array(), $has_content = FALSE, $default_defaults = array(), $default_allowed_types = array()) { |
344 | 345 | // Get a list of all types that are available |
@@ -375,9 +376,7 @@ discard block |
||
375 | 376 | * |
376 | 377 | * @ingroup forms |
377 | 378 | * |
378 | - * @param array $allowed_layouts |
|
379 | - * The set of allowed layouts that should be used as the default values |
|
380 | - * for this form. If none is provided, then by default no layouts will be restricted. |
|
379 | + * @param string $module_name |
|
381 | 380 | */ |
382 | 381 | function panels_common_allowed_layouts_form(&$form, &$form_state, $module_name) { |
383 | 382 | // Fetch our allowed layouts from variables. |
@@ -512,7 +511,8 @@ discard block |
||
512 | 511 | * if the actual layout name is needed in the middle, that can't happen. |
513 | 512 | * |
514 | 513 | * @return |
515 | - * The rendered output. |
|
514 | + string The rendered output. |
|
515 | + * @param string $base_path |
|
516 | 516 | */ |
517 | 517 | function panels_common_print_layout_links($layouts, $base_path, $link_options = array()) { |
518 | 518 | $output = ''; |
@@ -12,6 +12,7 @@ discard block |
||
12 | 12 | * Helper function for panels_edit_layout(). |
13 | 13 | * |
14 | 14 | * @see panels_edit_layout() for details on the various behaviors of this function. |
15 | + * @param string $finish |
|
15 | 16 | */ |
16 | 17 | function _panels_edit_layout($display, $finish, $destination, $allowed_layouts) { |
17 | 18 | ctools_include('common', 'panels'); |
@@ -171,16 +172,6 @@ discard block |
||
171 | 172 | * |
172 | 173 | * @ingroup forms |
173 | 174 | * |
174 | - * @param array $form |
|
175 | - * A structured FAPI $form array. |
|
176 | - * @param object $display instanceof panels_display \n |
|
177 | - * The panels_display object that was modified on the preceding display layout |
|
178 | - * editing form. |
|
179 | - * @param string $new_layout_id |
|
180 | - * A string containing the name of the layout the display is to be converted to. |
|
181 | - * These strings correspond exactly to the filenames of the *.inc files in panels/layouts. |
|
182 | - * So, if the new layout that's been selected is the 'Two Column bricks' layout, then |
|
183 | - * $new_layout_id will be 'twocol_bricks', corresponding to panels/layouts/twocol_bricks.inc. |
|
184 | 175 | */ |
185 | 176 | function panels_change_layout(&$form_state) { |
186 | 177 | $display = &$form_state['display']; |
@@ -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'); |