Changeset 9877 for trunk/src/bp-members/classes/class-bp-signup.php

Timestamp:

05/19/2015 01:40:26 AM (9 years ago)

Author:

tw2113

Message:

First pass at members component docs cleanup.

See #6402.

File:

• trunk/src/bp-members/classes/class-bp-signup.php (modified) (10 diffs)

trunk/src/bp-members/classes/class-bp-signup.php

@@ -111 +111 @@
      * @since BuddyPress (2.0.0)
      *
-     * @param array $args the argument to retrieve desired signups
+     * @param array $args the argument to retrieve desired signups.
+     *
      * @return array {
      *     @type array $signups Located signups.
-     *     @type int $total Total number of signups matching params.
+     *     @type int   $total   Total number of signups matching params.
      * }
      */
@@ -258 +259 @@
      *
      * @param array $args
+     *
      * @return int|bool ID of newly created signup on success, false on
-     *         failure.
+     *                  failure.
      */
     public static function add( $args = array() ) {
@@ -314 +316 @@
      * @since BuddyPress (2.0.0)
      *
-     * @param string $user_login User login string.
+     * @param string $user_login    User login string.
      * @param string $user_password User password.
-     * @param string $user_email User email address.
-     * @param array $usermeta Metadata associated with the signup.
+     * @param string $user_email    User email address.
+     * @param array  $usermeta      Metadata associated with the signup.
+     *
      * @return int User id.
      */
@@ -380 +383 @@
      *
      * @param int $user_id ID of the user being checked.
+     *
      * @return int|bool The status if found, otherwise false.
      */
@@ -407 +411 @@
      *
      * @param string $key Activation key.
+     *
      * @return bool True on success, false on failure.
      */
@@ -452 +457 @@
      * @since BuddyPress (2.0.0)
      *
-     * @return int the number of signups
+     * @return int The number of signups.
      */
     public static function count_signups() {
@@ -478 +483 @@
      * @since BuddyPress (2.0.0)
      *
-     * @param  array $args
-     * @return int the signup id
+     * @param array $args
+     *
+     * @return int The signup id
      */
     public static function update( $args = array() ) {
@@ -533 +539 @@
      *
      * @param array $signup_ids Single ID or list of IDs to resend.
+     *
      * @return array
      */
@@ -622 +629 @@
      *
      * @param array $signup_ids Single ID or list of IDs to activate.
+     *
      * @return array
      */
@@ -704 +712 @@
      *
      * @param array $signup_ids Single ID or list of IDs to delete.
+     *
      * @return array
      */