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

trunk/bp-core/bp-core-functions.php

@@ -88 +88 @@
  * Format numbers the BuddyPress way
  *
- * @param str $number
+ * @param int $number
  * @param bool $decimals
- * @return str
+ * @return string
  */
 function bp_core_number_format( $number, $decimals = false ) {
@@ -245 +245 @@
  * @since BuddyPress (1.5)
  *
- * @return obj $pages Page names, IDs, and slugs
+ * @return object Page names, IDs, and slugs
  */
 function bp_core_get_directory_pages() {
@@ -394 +394 @@
  * @since BuddyPress (1.5)
  *
- * @param str $root_slug The root slug, which comes from $bp->pages->[component]->slug
- * @return str $slug The short slug for use in the middle of URLs
+ * @param string $root_slug The root slug, which comes from $bp->pages->[component]->slug
+ * @return string The short slug for use in the middle of URLs
  */
 function bp_core_component_slug_from_root_slug( $root_slug ) {
@@ -410 +410 @@
  *
  * @global $bp BuddyPress global settings
- * @param $slug str The slug of the component
+ * @param string $slug The slug of the component
  */
 function bp_core_add_root_component( $slug ) {
@@ -470 +470 @@
  * @package BuddyPress Core
  * @uses get_blog_option() WordPress function to fetch blog meta.
- * @return $domain The domain URL for the blog.
+ * @return string The domain URL for the blog.
  */
 function bp_core_get_root_domain() {
@@ -505 +505 @@
  *
  * @package BuddyPress Core
- * @return The referrer URL
+ * @return string The referrer URL
  */
 function bp_core_referrer() {
@@ -578 +578 @@
  * @uses apply_filters() Filter 'bp_core_time_since_pre' to bypass BP's calculations
  * @uses apply_filters() Filter 'bp_core_time_since' to modify BP's calculations
- * @param $older_date int Unix timestamp of date you want to calculate the time since for
- * @param $newer_date int Unix timestamp of date to compare older date to. Default false (current time).
- * @return str The time since.
+ * @param int $older_date Unix timestamp of date you want to calculate the time since for
+ * @param int $newer_date Unix timestamp of date to compare older date to. Default false (current time).
+ * @return string The time since.
  */
 function bp_core_time_since( $older_date, $newer_date = false ) {
@@ -734 +734 @@
  *
  * @global BuddyPress $bp The one true BuddyPress instance
- * @param str $message Feedback to give to user
- * @param str $type updated|success|error|warning
+ * @param string $message Feedback to give to user
+ * @param string $type updated|success|error|warning
  */
 function bp_core_add_message( $message, $type = '' ) {
@@ -855 +855 @@
  *
  * @package BuddyPress Core
- * @param last_activity_date The date of last activity.
- * @param $before The text to prepend to the activity time since figure.
- * @param $after The text to append to the activity time since figure.
+ * @param string $last_activity_date The date of last activity.
+ * @param string $string
  * @uses bp_core_time_since() This function will return an English representation of the time elapsed.
  */
@@ -889 +888 @@
  *
  * @uses apply_filters() Filter bp_get_user_meta_key to modify keys individually
- * @param str $key
- * @return str $key
+ * @param string $key
+ * @return string $key
  */
 function bp_get_user_meta_key( $key = false ) {
@@ -1212 +1211 @@
  * @global BuddyPress $bp The one true BuddyPress instance
  * @param bool $is_directory
- * @param str $component
+ * @param string $component
  */
 function bp_update_is_directory( $is_directory = false, $component = '' ) {
@@ -1228 +1227 @@
  * @global BuddyPress $bp The one true BuddyPress instance
  * @param bool $is_item_admin
- * @param str $component
+ * @param string $component
  */
 function bp_update_is_item_admin( $is_item_admin = false, $component = '' ) {
@@ -1244 +1243 @@
  * @global BuddyPress $bp The one true BuddyPress instance
  * @param bool $is_item_mod
- * @param str $component
+ * @param string $component
  */
 function bp_update_is_item_mod( $is_item_mod = false, $component = '' ) {