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

Timestamp:

10/28/2015 04:07:50 AM (9 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/capabilities.php (modified) (15 diffs)

trunk/src/includes/users/capabilities.php

@@ -13 +13 @@
  * Maps primary capabilities
  *
- * @since bbPress (r4242)
+ * @since 2.2.0 bbPress (r4242)
  *
  * @param array  $caps Capabilities for meta capability.
@@ -124 +124 @@
  * Return a user's main role
  *
- * @since bbPress (r3860)
+ * @since 2.1.0 bbPress (r3860)
  *
  * @param int $user_id
@@ -177 +177 @@
  * Return a user's forums role
  *
- * @since bbPress (r3860)
+ * @since 2.1.0 bbPress (r3860)
  *
  * @param int $user_id
@@ -215 +215 @@
  * Return a user's blog role
  *
- * @since bbPress (r4446)
+ * @since 2.3.0 bbPress (r4446)
  *
  * @param int $user_id
@@ -257 +257 @@
  * update user roles and capabilities.
  *
- * @since bbPress (r4235)
+ * @since 2.2.0 bbPress (r4235)
  *
  * @param int $user_id
@@ -304 +304 @@
  * installation of WordPress, or if the user is marked as spam or deleted.
  *
- * @since bbPress (r3380)
+ * @since 2.0.0 bbPress (r3380)
  *
  * @uses is_user_logged_in() To bail if user is not logged in
@@ -395 +395 @@
  * role in the forums. Also guarantees WordPress admins get the Keymaster role.
  *
- * @since bbPress (r4334)
+ * @since 2.2.0 bbPress (r4334)
  *
  * @return array Filtered array of WordPress roles to bbPress roles
@@ -419 +419 @@
  * Checks if the user has been marked as a spammer.
  *
- * @since bbPress (r3355)
+ * @since 2.0.0 bbPress (r3355)
  *
  * @param int $user_id int The ID for the user.
@@ -457 +457 @@
  * Mark a users topics and replies as spam when the user is marked as spam
  *
- * @since bbPress (r3405)
+ * @since 2.0.0 bbPress (r3405)
  *
  * @param int $user_id Optional. User ID to spam. Defaults to displayed user.
@@ -549 +549 @@
  * Mark a users topics and replies as spam when the user is marked as spam
  *
- * @since bbPress (r3405)
+ * @since 2.0.0 bbPress (r3405)
  *
  * @param int $user_id Optional. User ID to unspam. Defaults to displayed user.
@@ -640 +640 @@
  * Checks if the user has been marked as deleted.
  *
- * @since bbPress (r3355)
+ * @since 2.0.0 bbPress (r3355)
  *
  * @param int $user_id int The ID for the user.
@@ -678 +678 @@
  * Checks if user is active
  *
- * @since bbPress (r3502)
+ * @since 2.0.0 bbPress (r3502)
  *
  * @uses is_user_logged_in() To check if user is logged in
@@ -717 +717 @@
  * Checks if user is not active.
  *
- * @since bbPress (r3502)
+ * @since 2.0.0 bbPress (r3502)
  *
  * @uses is_user_logged_in() To check if user is logged in
@@ -745 +745 @@
  * Checks if user is a keymaster
  *
- * @since bbPress (r4783)
+ * @since 2.3.0 bbPress (r4783)
  *
  * @param int $user_id
@@ -762 +762 @@
  * Does a user have a profile for the current site
  *
- * @since bbPress (r4362)
+ * @since 2.2.0 bbPress (r4362)
  *
  * @param int $user_id User ID to check