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

trunk/bp-groups/bp-groups-functions.php

@@ -37 +37 @@
  * support and pass through the groups_get_group filter.
  *
- * @param $args The load_users parameter is deprecated and does nothing.
- * @return obj $group The group object
+ * @param string $args The load_users parameter is deprecated and does nothing.
+ * @return BP_Groups_Group $group The group object
  */
 function groups_get_group( $args = '' ) {
@@ -524 +524 @@
  * @since BuddyPress (1.5)
  *
- * @return obj The current group object
+ * @return BP_Groups_Group The current group object
  */
 function groups_get_current_group() {
@@ -782 +782 @@
  * @param int $user_id Potential group member
  * @param int $group_id Potential group
- * @param str $type Optional. Use 'sent' to check for sent invites, 'all' to check for all
+ * @param string $type Optional. Use 'sent' to check for sent invites, 'all' to check for all
  * @return bool Returns true if an invitation is found
  */