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

Timestamp:

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

Author:

djpaul

Message:

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

File:

• trunk/bp-groups/bp-groups-template.php (modified) (10 diffs)

trunk/bp-groups/bp-groups-template.php

@@ -812 +812 @@
  * @since BuddyPress (1.5)
  *
- * @param obj $group (optional) The group being queried. Defaults to the current group in the loop
- * @param str $format 'string' to get a comma-separated string, 'array' to get an array
+ * @param BP_Groups_Group $group (optional) The group being queried. Defaults to the current group in the loop
+ * @param string $format 'string' to get a comma-separated string, 'array' to get an array
  * @return mixed $admin_ids A string or array of user_ids
  */
@@ -842 +842 @@
  * @since BuddyPress (1.5)
  *
- * @param obj $group (optional) The group being queried. Defaults to the current group in the loop
- * @param str $format 'string' to get a comma-separated string, 'array' to get an array
+ * @param BP_Groups_Group $group (optional) The group being queried. Defaults to the current group in the loop
+ * @param string $format 'string' to get a comma-separated string, 'array' to get an array
  * @return mixed $mod_ids A string or array of user_ids
  */
@@ -1082 +1082 @@
  * @since BuddyPress (1.5)
  *
- * @param str $setting The setting you want to check against ('members', 'mods', or 'admins')
- * @param obj $group (optional) The group whose status you want to check
+ * @param string $setting The setting you want to check against ('members', 'mods', or 'admins')
+ * @param BP_Groups_Group $group (optional) The group whose status you want to check
  */
 function bp_group_show_invite_status_setting( $setting, $group = false ) {
@@ -1673 +1673 @@
  * @since BuddyPress (1.2.7)
  *
- * @param obj|bool $group The BP Groups_Group object if passed, boolean false if not passed.
+ * @param BP_Groups_Group|bool $group The BP Groups_Group object if passed, boolean false if not passed.
  * @uses bp_get_group_new_topic_button() Returns the 'New Topic' button
  */
@@ -1684 +1684 @@
      * @since BuddyPress (1.2.7)
      *
-     * @param obj|bool $group The BP Groups_Group object if passed, boolean false if not passed.
+     * @param BP_Groups_Group|bool $group The BP Groups_Group object if passed, boolean false if not passed.
      * @uses is_user_logged_in() Is there a user logged in?
      * @uses bp_group_is_user_banned() Is the current user banned from the current group?
@@ -1690 +1690 @@
      * @uses bp_is_group_forum_topic() Are we on a group topic page?
      * @uses bp_get_button() Renders a button
-     * @return HTML code for the button
+     * @return string HTML code for the button
      */
     function bp_get_group_new_topic_button( $group = false ) {
@@ -2417 +2417 @@
      *
      * @uses apply_filters() Filter bp_get_groups_current_create_step to modify
-     * @return str $current_create_step
+     * @return string $current_create_step
      */
     function bp_get_groups_current_create_step() {
@@ -2583 +2583 @@
      *
      * @uses apply_filters() Filter bp_get_current_group_admin_tab to modify return value
-     * @return str $tab The current tab's slug
+     * @return string $tab The current tab's slug
      */
     function bp_get_group_current_admin_tab() {
@@ -3041 +3041 @@
      * @uses apply_filters() Filter bp_get_current_group_slug to modify this output
      *
-     * @return str $current_group_slug The slug of the current group, if there is one
+     * @return string $current_group_slug The slug of the current group, if there is one
      */
     function bp_get_current_group_slug() {
@@ -3066 +3066 @@
      * @uses apply_filters() Filter bp_get_current_group_name to modify this output
      *
-     * @return str The name of the current group, if there is one
+     * @return string The name of the current group, if there is one
      */
     function bp_get_current_group_name() {