Changeset 9906 for trunk/src/bp-groups/classes/class-bp-groups-member-suggestions.php

Timestamp:

06/02/2015 05:21:07 AM (9 years ago)

Author:

tw2113

Message:

Initial documentation cleanup for the BP Groups component.

See #6401.

File:

• trunk/src/bp-groups/classes/class-bp-groups-member-suggestions.php (modified) (4 diffs)

trunk/src/bp-groups/classes/class-bp-groups-member-suggestions.php

@@ -1 +1 @@
 <?php
 /**
- * BuddyPress Groups Classes
+ * BuddyPress Groups Classes.
  *
  * @package BuddyPress
@@ -23 +23 @@
      * @access protected
      * @var array $args {
-     *     @type int $group_id Positive integers will restrict the search to members in that group.
-     *           Negative integers will restrict the search to members in every other group.
-     *     @type int $limit Maximum number of results to display. Default: 16.
-     *     @type bool $only_friends If true, only match the current user's friends. Default: false.
-     *     @type string $term The suggestion service will try to find results that contain this string.
-     *           Mandatory.
+     *     @type int    $group_id     Positive integers will restrict the search to members in that group.
+     *                                Negative integers will restrict the search to members in every other group.
+     *     @type int    $limit        Maximum number of results to display. Default: 16.
+     *     @type bool   $only_friends If true, only match the current user's friends. Default: false.
+     *     @type string $term         The suggestion service will try to find results that contain this string.
+     *                                Mandatory.
      * }
      */
@@ -43 +43 @@
      * Validate and sanitise the parameters for the suggestion service query.
      *
+     * @since BuddyPress (2.1.0)
+     *
      * @return true|WP_Error If validation fails, return a WP_Error object. On success, return true (bool).
-     * @since BuddyPress (2.1.0)
      */
     public function validate() {
@@ -88 +89 @@
      * Find and return a list of username suggestions that match the query.
      *
+     * @since BuddyPress (2.1.0)
+     *
      * @return array|WP_Error Array of results. If there were problems, returns a WP_Error object.
-     * @since BuddyPress (2.1.0)
      */
     public function get_suggestions() {