Changeset 9046

Timestamp:

09/27/2014 12:41:29 AM (11 years ago)

Author:

boonebgorges

Message:

Some improvements to inline documentation in bp-groups-template.php

See #5022

File:

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

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

@@ -1508 +1508 @@
 }
 
+/**
+ * Determine whether the displayed user has no groups.
+ *
+ * No longer used in BuddyPress.
+ *
+ * @todo Deprecate
+ *
+ * @return bool True if the displayed user has no groups, otherwise false.
+ */
 function bp_group_show_no_groups_message() {
     if ( !groups_total_groups_for_user( bp_displayed_user_id() ) )
@@ -1515 +1524 @@
 }
 
+/**
+ * Determine whether the current page is a group activity permalink.
+ *
+ * No longer used in BuddyPress.
+ *
+ * @todo Deprecate.
+ *
+ * @return bool True if this is a group activity permalink, otherwise false.
+ */
 function bp_group_is_activity_permalink() {
 
@@ -1523 +1541 @@
 }
 
+/**
+ * Output the pagination HTML for a group loop.
+ */
 function bp_groups_pagination_links() {
     echo bp_get_groups_pagination_links();
 }
+    /**
+     * Get the pagination HTML for a group loop.
+     *
+     * @return string
+     */
     function bp_get_groups_pagination_links() {
         global $groups_template;
@@ -1532 +1558 @@
     }
 
+/**
+ * Output the "Viewing x-y of z groups" pagination message.
+ */
 function bp_groups_pagination_count() {
     echo bp_get_groups_pagination_count();
 }
+    /**
+     * Generate the "Viewing x-y of z groups" pagination message.
+     *
+     * @return string
+     */
     function bp_get_groups_pagination_count() {
         global $groups_template;
@@ -1546 +1580 @@
     }
 
+/**
+ * Determine whether groups auto-join is enabled.
+ *
+ * "Auto-join" is the toggle that determines whether users are joined to a
+ * public group automatically when creating content in that group.
+ *
+ * @return bool
+ */
 function bp_groups_auto_join() {
     global $bp;
@@ -1552 +1594 @@
 }
 
+/**
+ * Output the total member count for a group.
+ *
+ * @param object $group Optional. Group object. Default: current group in loop.
+ */
 function bp_group_total_members( $group = false ) {
     echo bp_get_group_total_members( $group );
 }
+    /**
+     * Get the total member count for a group.
+     *
+     * @param object $group Optional. Group object. Default: current group in loop.
+     * @return int
+     */
     function bp_get_group_total_members( $group = false ) {
         global $groups_template;
@@ -1564 +1617 @@
     }
 
+/**
+ * Output the "x members" count string for a group.
+ *
+ * @param object $group Optional. Group object. Default: current group in loop.
+ */
 function bp_group_member_count() {
     echo bp_get_group_member_count();
 }
+    /**
+     * Generate the "x members" count string for a group.
+     *
+     * @param object $group Optional. Group object. Default: current group in loop.
+     * @return string
+     */
     function bp_get_group_member_count() {
         global $groups_template;