Changeset 10821 for trunk/src/bp-forums/bp-forums-bbpress-sa.php

Timestamp:

05/29/2016 07:08:27 AM (9 years ago)

Author:

tw2113

Message:

Plenty of @since tags for the BP Forums component.

See #6399.

File:

• trunk/src/bp-forums/bp-forums-bbpress-sa.php (modified) (11 diffs)

trunk/src/bp-forums/bp-forums-bbpress-sa.php

@@ -13 +13 @@
 /**
  * Bootstrap bbPress 1.x, and manipulate globals to integrate with BuddyPress.
+ *
+ * @since 1.1.0
  *
  * @return bool|null Returns false on failure.
@@ -157 +159 @@
  * Get the current bbPress user.
  *
+ * @since 1.1.0
+ *
  * @return object $current_user Current user object from WordPress.
  */
@@ -163 +167 @@
 /**
  * Get userdata for a bbPress user.
+ *
+ * @since 1.1.0
  *
  * @param int $user_id User ID.
@@ -174 +180 @@
  * Noop.
  *
+ * @since 1.1.0
+ *
  * @param array $users Array of users.
  */
@@ -180 +188 @@
 /**
  * The bbPress plugin needs this class for its usermeta manipulation.
+ *
+ * @since 1.1.0
  */
 class BP_Forums_BB_Auth {
+
+    /**
+     * Update usermeta data.
+     *
+     * @since 1.1.0
+     *
+     * @param string $args Array of arguments.
+     * @return bool
+     */
     function update_meta( $args = '' ) {
         $defaults = array( 'id' => 0, 'meta_key' => null, 'meta_value' => null, 'meta_table' => 'usermeta', 'meta_field' => 'user_id', 'cache_group' => 'users' );
@@ -199 +218 @@
  */
 if ( ! class_exists( 'BPDB' ) ) :
+
+    /**
+     * WPDB class extension.
+     *
+     * @since 1.1.0
+     */
     class BPDB extends WPDB {
         var $db_servers = array();
@@ -204 +229 @@
         /**
          * Constructor.
+         *
+         * @since 1.1.0
          *
          * @see WPDB::__construct() for description of parameters.
@@ -226 +253 @@
          * supported by WordPress' minimum required MySQL version, so
          * this is safe.
+         *
+         * @since 1.1.0
          *
          * @see WPDB::has_cap() for a description of parameters and
@@ -280 +309 @@
          * Stub for escape_deep() compatibility.
          *
+         * @since 1.1.0
+         *
          * @see WPDB::escape_deep() for description of parameters and
          *      return values.
@@ -296 +327 @@
  *
  * The bbPress plugin needs this to convert vars.
+ *
+ * @since 1.1.0
  *
  * @param object $object Object to convert.
@@ -318 +351 @@
  * Copied from wp-admin/includes/upgrade.php, this will take care of creating
  * the bbPress stand-alone tables without loading a conflicting WP Admin.
+ *
+ * @since 1.5.0
  *
  * @see dbDelta() for a description of parameters and return value.