Changeset 7228 for trunk/bp-core/bp-core-options.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-options.php (modified) (15 diffs)

trunk/bp-core/bp-core-options.php

@@ -198 +198 @@
  *
  * @uses bp_get_root_blog_id()
- * @param str $option_name The option to be retrieved
- * @param str $default Optional. Default value to be returned if the option isn't set
+ * @param string $option_name The option to be retrieved
+ * @param string $default Optional. Default value to be returned if the option isn't set
  * @return mixed The value for the option
  */
@@ -218 +218 @@
  *
  * @uses bp_get_root_blog_id()
- * @param str $option_name The option key to be set
- * @param str $value The value to be set
+ * @param string $option_name The option key to be set
+ * @param string $value The value to be set
  */
 function bp_update_option( $option_name, $value ) {
@@ -235 +235 @@
  *
  * @uses bp_get_root_blog_id()
- * @param str $option_name The option key to be set
+ * @param string $option_name The option key to be set
  */
 function bp_delete_option( $option_name ) {
@@ -378 +378 @@
  * @since BuddyPress (1.6)
  *
- * @param $default bool Optional.Default value true
+ * @param bool $default Optional.Default value true
  *
  * @uses bp_get_option() To get the profile sync option
@@ -392 +392 @@
  * @since BuddyPress (1.6)
  *
- * @param $default bool Optional.Default value true
+ * @param bool $default Optional.Default value true
  *
  * @uses bp_get_option() To get the logged out Toolbar option
@@ -406 +406 @@
  * @since BuddyPress (1.6)
  *
- * @param $default bool Optional. Default value true
+ * @param bool $default Optional. Default value true
  *
  * @uses bp_get_option() To get the avatar uploads option
@@ -420 +420 @@
  * @since BuddyPress (1.6)
  *
- * @param $default bool Optional. Default value
+ * @param bool $default Optional. Default value
  *
  * @uses bp_get_option() To get the account deletion option
@@ -434 +434 @@
  * @since BuddyPress (1.6)
  *
- * @param $default bool Optional. Default value false
+ * @param bool $default Optional. Default value false
  * @todo split and move into blog and forum components
  * @uses bp_get_option() To get the blog/forum comments option
@@ -448 +448 @@
  * @since BuddyPress (1.6)
  *
- * @param $default bool Optional. Default value true
+ * @param bool $default Optional. Default value true
  *
  * @todo Move into groups component
@@ -463 +463 @@
  * @since BuddyPress (1.6)
  *
- * @param $default bool Optional. Default value true
+ * @param bool $default Optional. Default value true
  *
  * @todo Move into groups component
@@ -478 +478 @@
  * @since BuddyPress (1.6)
  *
- * @param $default bool Optional. Default value
+ * @param bool $default Optional. Default value
  */
 function bp_group_forums_root_id( $default = '0' ) {
@@ -488 +488 @@
      * @since BuddyPress (1.6)
      *
-     * @param $default bool Optional. Default value 0
+     * @param bool $default Optional. Default value 0
      *
      * @uses bp_get_option() To get the maximum title length
@@ -502 +502 @@
  * @since BuddyPress (1.6)
  *
- * @param $default bool Optional. Default value true
+ * @param bool $default Optional. Default value true
  *
  * @uses bp_get_option() To get the group forums option
@@ -516 +516 @@
  * @since BuddyPress (1.6)
  *
- * @param $default bool Optional. Default value true
+ * @param bool $default Optional. Default value true
  *
  * @uses bp_get_option() To get the Akismet option
@@ -530 +530 @@
  * @since BuddyPress (1.7)
  *
- * @param $default string Optional. Default value 'default'
+ * @param string $default Optional. Default value 'default'
  * @uses get_option() To get the subtheme option
  * @return string ID of the subtheme