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

Timestamp:

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

Author:

tw2113

Message:

First pass at BP-Core docs cleanup.

See #6398.

File:

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

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

@@ -70 +70 @@
      *
      * @param array $args {
-     *     @type int $limit Maximum number of results to display. Optional, default: 16.
-     *     @type string $type The name of the suggestion service to use for the request. Mandatory.
-     *     @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. Optional, default: 16.
+     *     @type string $type  The name of the suggestion service to use for the request. Mandatory.
+     *     @type string $term  The suggestion service will try to find results that contain this string.
+     *                         Mandatory.
      * }
      * @since BuddyPress (2.1.0)
@@ -87 +87 @@
      * If validation fails, you must return a WP_Error object.
      *
+     * @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() {
@@ -134 +135 @@
      * For example: { 'ID': 'admin', 'image': 'http://example.com/logo.png', 'name': 'Name Surname' }
      *
+     * @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)
      */
     abstract public function get_suggestions();