Changeset 7228 for trunk/bp-core/bp-core-template.php

Timestamp:

06/19/2013 09:41:08 PM (12 years ago)

Author:

djpaul

Message:

Quick audit of existing phpDoc @param, @return, and @since parameters. Fixes #5031

File:

• trunk/bp-core/bp-core-template.php (modified) (5 diffs)

trunk/bp-core/bp-core-template.php

@@ -623 +623 @@
  *
  * @param int $position The key of the action_variables array that you want
- * @return str $action_variable The value of that position in the array
+ * @return string $action_variable The value of that position in the array
  */
 function bp_action_variable( $position = 0 ) {
@@ -712 +712 @@
  * @since BuddyPress (1.5)
  * @global BuddyPress $bp The one true BuddyPress instance
- * @param str $root_slug Needle to our active component haystack
+ * @param string $root_slug Needle to our active component haystack
  * @return mixed False if none found, component name if found
  */
@@ -884 +884 @@
  * @since BuddyPress (1.5)
  *
- * @param str $action The action being tested against
+ * @param string $action The action being tested against
  * @return bool True if the current action matches $action
  */
@@ -908 +908 @@
  * @since BuddyPress (1.5)
  *
- * @param str $action_variable The action_variable being tested against
+ * @param string $action_variable The action_variable being tested against
  * @param int $position The array key you're testing against. If you don't provide a $position,
  *   the function will return true if the $action_variable is found *anywhere* in the action
@@ -985 +985 @@
  *
  * @package BuddyPress Core
- * @return true if root component, else false.
+ * @return bool True if root component, else false.
  */
 function bp_is_root_component( $component_name ) {