Changeset 10012 for trunk/src/bp-core/classes/class-bp-members-suggestions.php

Timestamp:

07/12/2015 12:49:36 AM (9 years ago)

Author:

tw2113

Message:

First pass at BP-Core docs cleanup.

See #6398.

File:

• trunk/src/bp-core/classes/class-bp-members-suggestions.php (modified) (3 diffs)

trunk/src/bp-core/classes/class-bp-members-suggestions.php

@@ -25 +25 @@
      * @since BuddyPress (2.1.0)
      * @var array $args {
-     *     @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    $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.
      * }
      */
@@ -42 +42 @@
      * 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() {
@@ -77 +78 @@
      * 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() {