Changeset 5951 for trunk/src/includes/core/capabilities.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/core/capabilities.php (modified) (18 diffs)

trunk/src/includes/core/capabilities.php

@@ -20 +20 @@
  * Returns an array of capabilities based on the role that is being requested.
  *
- * @since bbPress (r2994)
+ * @since 2.0.0 bbPress (r2994)
  *
  * @todo Map all of these and deprecate
@@ -212 +212 @@
  * Adds capabilities to WordPress user roles.
  *
- * @since bbPress (r2608)
+ * @since 2.0.0 bbPress (r2608)
  */
 function bbp_add_caps() {
@@ -229 +229 @@
  * Removes capabilities from WordPress user roles.
  *
- * @since bbPress (r2608)
+ * @since 2.0.0 bbPress (r2608)
  */
 function bbp_remove_caps() {
@@ -246 +246 @@
  * Get the `$wp_roles` global without needing to declare it everywhere
  *
- * @since bbPress (r4293)
+ * @since 2.2.0 bbPress (r4293)
  *
  * @return WP_Roles
@@ -266 +266 @@
  * Get the available roles minus bbPress's dynamic roles
  *
- * @since bbPress (r5064)
+ * @since 2.4.0 bbPress (r5064)
  *
  * @uses bbp_get_wp_roles() To load and get the $wp_roles global
@@ -293 +293 @@
  * We do this to avoid adding these values to the database.
  *
- * @since bbPress (r4290)
+ * @since 2.2.0 bbPress (r4290)
  *
  * @uses bbp_get_wp_roles() To load and get the $wp_roles global
@@ -314 +314 @@
  * Helper function to add filter to option_wp_user_roles
  *
- * @since bbPress (r4363)
+ * @since 2.2.0 bbPress (r4363)
  *
  * @see _bbp_reinit_dynamic_roles()
@@ -340 +340 @@
  * @see WP_Roles::_init()
  *
- * @since bbPress (r4363)
+ * @since 2.2.0 bbPress (r4363)
  *
  * @internal Used by bbPress to reinitialize dynamic roles on blog switch
@@ -367 +367 @@
  * user management.
  *
- * @since bbPress (r4284)
+ * @since 2.2.0 bbPress (r4284)
  *
  * @return array
@@ -409 +409 @@
  * Gets a translated role name from a role ID
  *
- * @since bbPress (r4792)
+ * @since 2.3.0 bbPress (r4792)
  *
  * @param string $role_id
@@ -427 +427 @@
  * Need to research what happened, and if there's a way to speed this up.
  *
- * @since bbPress (r4303)
+ * @since 2.2.0 bbPress (r4303)
  *
  * @param array $all_roles All registered roles
@@ -453 +453 @@
  * The keymaster role for bbPress users
  *
- * @since bbPress (r4284)
+ * @since 2.2.0 bbPress (r4284)
  *
  * @uses apply_filters() Allow override of hardcoded keymaster role
@@ -465 +465 @@
  * The moderator role for bbPress users
  *
- * @since bbPress (r3410)
+ * @since 2.0.0 bbPress (r3410)
  *
  * @uses apply_filters() Allow override of hardcoded moderator role
@@ -477 +477 @@
  * The participant role for registered user that can participate in forums
  *
- * @since bbPress (r3410)
+ * @since 2.0.0 bbPress (r3410)
  *
  * @uses apply_filters() Allow override of hardcoded participant role
@@ -489 +489 @@
  * The spectator role is for registered users without any capabilities
  *
- * @since bbPress (r3860)
+ * @since 2.1.0 bbPress (r3860)
  *
  * @uses apply_filters() Allow override of hardcoded spectator role
@@ -501 +501 @@
  * The blocked role is for registered users that cannot spectate or participate
  *
- * @since bbPress (r4284)
+ * @since 2.2.0 bbPress (r4284)
  *
  * @uses apply_filters() Allow override of hardcoded blocked role
@@ -513 +513 @@
  * Adds bbPress-specific user roles.
  *
- * @since bbPress (r2741)
- * @deprecated since version 2.2
+ * @since 2.0.0 bbPress (r2741)
+ *
+ * @deprecated 2.2.0 bbPress (r4164)
  */
 function bbp_add_roles() {
@@ -529 +530 @@
  * @see bbp_version_updater()
  *
- * @since bbPress (r2741)
+ * @since 2.0.0 bbPress (r2741)
  */
 function bbp_remove_roles() {