Changeset 5951 for trunk/src/includes/users/functions.php

Timestamp:

10/28/2015 04:07:50 AM (10 years ago)

Author:

netweb

Message:

Standardize @since PHPDoc tags style and format

• e.g. @since 2.6.0 bbPress (r5951) YOLO
• See ​http://phpdoc.org/docs/latest/references/phpdoc/tags/since.html

This changeset updates the style and formatting of all of our @since instances for compatibility with phpDocumentor 2 and WP-Parser as we move toward implementing the bbPress developer code reference.

Props thebrandonallen
Fixes #2879

File:

• trunk/src/includes/users/functions.php (modified) (51 diffs)

trunk/src/includes/users/functions.php

@@ -14 +14 @@
  * Redirect back to $url when attempting to use the login page
  *
- * @since bbPress (r2815)
+ * @since 2.0.0 bbPress (r2815)
  *
  * @param string $url The url
@@ -46 +46 @@
  * Is an anonymous topic/reply being made?
  *
- * @since bbPress (r2688)
+ * @since 2.0.0 bbPress (r2688)
  *
  * @uses is_user_logged_in() Is the user logged in?
@@ -67 +67 @@
  * Echoes the values for current poster (uses WP comment cookies)
  *
- * @since bbPress (r2734)
+ * @since 2.0.0 bbPress (r2734)
  *
  * @param string $key Which value to echo?
@@ -80 +80 @@
      * Get the cookies for current poster (uses WP comment cookies).
      *
-     * @since bbPress (r2734)
+     * @since 2.0.0 bbPress (r2734)
      *
      * @param string $key Optional. Which value to get? If not given, then
@@ -114 +114 @@
  * Set the cookies for current poster (uses WP comment cookies)
  *
- * @since bbPress (r2734)
+ * @since 2.0.0 bbPress (r2734)
  *
  * @param array $anonymous_data With keys 'bbp_anonymous_name',
@@ -160 +160 @@
  * Get the poster user agent
  *
- * @since bbPress (r3446)
+ * @since 2.0.0 bbPress (r3446)
  *
  * @return string
@@ -175 +175 @@
  * Get the users who have made the topic favorite
  *
- * @since bbPress (r2658)
+ * @since 2.0.0 bbPress (r2658)
  *
  * @param int $topic_id Optional. Topic id
@@ -203 +203 @@
  * Get a user's favorite topics
  *
- * @since bbPress (r2652)
+ * @since 2.0.0 bbPress (r2652)
  *
  * @param int $user_id Optional. User id
@@ -232 +232 @@
  * Get a user's favorite topics' ids
  *
- * @since bbPress (r2652)
+ * @since 2.0.0 bbPress (r2652)
  *
  * @param int $user_id Optional. User id
@@ -256 +256 @@
  * Check if a topic is in user's favorites or not
  *
- * @since bbPress (r2652)
+ * @since 2.0.0 bbPress (r2652)
  *
  * @param int $user_id Optional. User id
@@ -306 +306 @@
  * Add a topic to user's favorites
  *
- * @since bbPress (r2652)
+ * @since 2.0.0 bbPress (r2652)
  *
  * @param int $user_id Optional. User id
@@ -343 +343 @@
  * Remove a topic from user's favorites
  *
- * @since bbPress (r2652)
+ * @since 2.0.0 bbPress (r2652)
  *
  * @param int $user_id Optional. User id
@@ -492 +492 @@
  * Get the users who have subscribed to the forum
  *
- * @since bbPress (r5156)
+ * @since 2.5.0 bbPress (r5156)
  *
  * @param int $forum_id Optional. forum id
@@ -519 +519 @@
  * Get the users who have subscribed to the topic
  *
- * @since bbPress (r2668)
+ * @since 2.0.0 bbPress (r2668)
  *
  * @param int $topic_id Optional. Topic id
@@ -546 +546 @@
  * Get a user's subscribed topics
  *
- * @since bbPress (r2668)
- *
- * @deprecated since bbPress (r5156)
+ * @since 2.0.0 bbPress (r2668)
+ *
+ * @deprecated 2.5.0 bbPress (r5156)
  *
  * @param int $user_id Optional. User id
@@ -563 +563 @@
  * Get a user's subscribed topics
  *
- * @since bbPress (r2668)
+ * @since 2.0.0 bbPress (r2668)
  *
  * @param int $user_id Optional. User id
@@ -594 +594 @@
  * Get a user's subscribed forums
  *
- * @since bbPress (r5156)
+ * @since 2.5.0 bbPress (r5156)
  *
  * @param int $user_id Optional. User id
@@ -625 +625 @@
  * Get a user's subscribed forum ids
  *
- * @since bbPress (r5156)
+ * @since 2.5.0 bbPress (r5156)
  *
  * @param int $user_id Optional. User id
@@ -649 +649 @@
  * Get a user's subscribed topics' ids
  *
- * @since bbPress (r2668)
+ * @since 2.0.0 bbPress (r2668)
  *
  * @param int $user_id Optional. User id
@@ -673 +673 @@
  * Check if a topic or forum is in user's subscription list or not
  *
- * @since bbPress (r5156)
+ * @since 2.5.0 bbPress (r5156)
  *
  * @param int $user_id Optional. User id
@@ -727 +727 @@
  * Check if a forum is in user's subscription list or not
  *
- * @since bbPress (r5156)
+ * @since 2.5.0 bbPress (r5156)
  *
  * @param int $user_id Optional. User id
@@ -784 +784 @@
  * Check if a topic is in user's subscription list or not
  *
- * @since bbPress (r5156)
+ * @since 2.5.0 bbPress (r5156)
  *
  * @param int $user_id Optional. User id
@@ -841 +841 @@
  * Add a topic to user's subscriptions
  *
- * @since bbPress (r5156)
+ * @since 2.5.0 bbPress (r5156)
  *
  * @param int $user_id Optional. User id
@@ -887 +887 @@
  * Add a forum to user's subscriptions
  *
- * @since bbPress (r5156)
+ * @since 2.5.0 bbPress (r5156)
  *
  * @param int $user_id Optional. User id
@@ -924 +924 @@
  * Add a topic to user's subscriptions
  *
- * @since bbPress (r2668)
+ * @since 2.0.0 bbPress (r2668)
  *
  * @param int $user_id Optional. User id
@@ -961 +961 @@
  * Remove a topic from user's subscriptions
  *
- * @since bbPress (r2668)
+ * @since 2.0.0 bbPress (r2668)
  *
  * @param int $user_id Optional. User id
@@ -1007 +1007 @@
  * Remove a forum from user's subscriptions
  *
- * @since bbPress (r5156)
+ * @since 2.5.0 bbPress (r5156)
  *
  * @param int $user_id Optional. User id
@@ -1054 +1054 @@
  * Remove a topic from user's subscriptions
  *
- * @since bbPress (r5156)
+ * @since 2.5.0 bbPress (r5156)
  *
  * @param int $user_id Optional. User id
@@ -1101 +1101 @@
  * Handles the front end subscribing and unsubscribing forums
  *
- * @since bbPress (r5156)
+ * @since 2.5.0 bbPress (r5156)
  *
  * @param string $action The requested action to compare this function to
@@ -1206 +1206 @@
  * Handles the front end subscribing and unsubscribing topics
  *
- * @since bbPress (r2790)
+ * @since 2.0.0 bbPress (r2790)
  *
  * @param string $action The requested action to compare this function to
@@ -1313 +1313 @@
  * Handles the front end user editing from POST requests
  *
- * @since bbPress (r2790)
+ * @since 2.0.0 bbPress (r2790)
  *
  * @param string $action The requested action to compare this function to
@@ -1447 +1447 @@
  * Handles user email address updating from GET requests
  *
- * @since bbPress (r5660)
+ * @since 2.6.0 bbPress (r5660)
  *
  * @param string $action
@@ -1557 +1557 @@
  * Sends an email when an email address change occurs on POST requests
  *
- * @since bbPress (r5660)
+ * @since 2.6.0 bbPress (r5660)
  *
  * @see send_confirmation_on_profile_email()
@@ -1639 +1639 @@
  * also avoids needing to pollute the templates with additional logic and actions.
  *
- * @since bbPress (r4273)
+ * @since 2.2.0 bbPress (r4273)
  *
  * @uses bbp_is_user_home_edit() To switch the action fired
@@ -1656 +1656 @@
  * Get the topics that a user created
  *
- * @since bbPress (r2660)
+ * @since 2.0.0 bbPress (r2660)
  *
  * @param int $user_id Optional. User id
@@ -1682 +1682 @@
  * Get the replies that a user created
  *
- * @since bbPress (r4225)
+ * @since 2.2.0 bbPress (r4225)
  *
  * @param int $user_id Optional. User id
@@ -1710 +1710 @@
  * Get the total number of users on the forums
  *
- * @since bbPress (r2769)
+ * @since 2.0.0 bbPress (r2769)
+ *
  * @uses count_users() To execute our query and get the var back
  * @uses apply_filters() Calls 'bbp_get_total_users' with number of users
@@ -1725 +1726 @@
  * Return the raw database count of topics by a user
  *
- * @since bbPress (r3633)
+ * @since 2.1.0 bbPress (r3633)
  *
  * @param int $user_id User ID to get count for
@@ -1752 +1753 @@
  * Return the raw database count of replies by a user
  *
- * @since bbPress (r3633)
+ * @since 2.1.0 bbPress (r3633)
  *
  * @param int $user_id User ID to get count for
@@ -1779 +1780 @@
  * Bump the topic count for a user by a certain amount.
  *
- * @since bbPress (r5309)
+ * @since 2.6.0 bbPress (r5309)
  *
  * @param int $user_id
@@ -1817 +1818 @@
  * Bump the reply count for a user by a certain amount.
  *
- * @since bbPress (r5309)
+ * @since 2.6.0 bbPress (r5309)
  *
  * @param int $user_id
@@ -1856 +1857 @@
  * a topic is published.
  *
- * @since bbPress (r5309)
+ * @since 2.6.0 bbPress (r5309)
  *
  * @access
@@ -1875 +1876 @@
  * This is a helper function, hooked to `bbp_new_reply`
  *
- * @since bbPress (r5309)
+ * @since 2.6.0 bbPress (r5309)
  *
  * @param $topic_id
@@ -1891 +1892 @@
  * a topic is unpublished.
  *
- * @since bbPress (r5309)
+ * @since 2.6.0 bbPress (r5309)
  *
  * @param $topic_id
@@ -1904 +1905 @@
  * a topic is unpublished.
  *
- * @since bbPress (r5309)
+ * @since 2.6.0 bbPress (r5309)
  *
  * @param $reply_id
@@ -1918 +1919 @@
  * Return the term id for a given user id and taxonomy
  *
- * @since bbPress (r5834)
+ * @since 2.6.0 bbPress (r5834)
  *
  * @param int    $user_id User id.
@@ -1958 +1959 @@
  * Return the user id for a given term id and taxonomy
  *
- * @since bbPress (r5834)
+ * @since 2.6.0 bbPress (r5834)
  *
  * @param int    $term_id Term id.
@@ -2044 +2045 @@
  * earn the ability to access this template.
  *
- * @since bbPress (r3605)
+ * @since 2.1.0 bbPress (r3605)
  *
  * @uses bbp_is_single_user_edit()
@@ -2095 +2096 @@
  * Check if a user is blocked, or cannot spectate the forums.
  *
- * @since bbPress (r2996)
+ * @since 2.0.0 bbPress (r2996)
  *
  * @uses is_user_logged_in() To check if user is logged in
@@ -2133 +2134 @@
  *    existing installations that may have custom template parts.
  *
- * @since bbPress (r5368)
+ * @since 2.6.0 bbPress (r5368)
  *
  * @param string $value
@@ -2190 +2191 @@
  * Convert passwords from previous platfrom encryption to WordPress encryption.
  *
- * @since bbPress (r3813)
+ * @since 2.1.0 bbPress (r3813)
  */
 function bbp_user_maybe_convert_pass() {