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

Timestamp:

10/28/2015 04:07:50 AM (8 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/forums/functions.php (modified) (45 diffs)

trunk/src/includes/forums/functions.php

@@ -17 +17 @@
  * for the forum to function properly.
  *
- * @since bbPress (r3349)
+ * @since 2.0.0 bbPress (r3349)
  *
  * @uses bbp_parse_args()
@@ -643 +643 @@
  * Handle the saving of core forum metadata (Status, Visibility, and Type)
  *
- * @since bbPress (r3678)
+ * @since 2.1.0 bbPress (r3678)
+ *
  * @param int $forum_id
  * @uses bbp_is_forum_closed() To check if forum is closed
@@ -727 +728 @@
          * Allow custom forum visibility save actions
          *
-         * @since bbPress (r5855)
+         * @since 2.6.0 bbPress (r5855)
          *
          * @param int    $forum_id       The forum ID
@@ -742 +743 @@
  * Closes a forum
  *
- * @since bbPress (r2746)
+ * @since 2.0.0 bbPress (r2746)
  *
  * @param int $forum_id forum id
@@ -766 +767 @@
  * Opens a forum
  *
- * @since bbPress (r2746)
+ * @since 2.0.0 bbPress (r2746)
  *
  * @param int $forum_id forum id
@@ -793 +794 @@
  * Make the forum a category
  *
- * @since bbPress (r2746)
+ * @since 2.0.0 bbPress (r2746)
  *
  * @param int $forum_id Optional. Forum id
@@ -815 +816 @@
  * Remove the category status from a forum
  *
- * @since bbPress (r2746)
+ * @since 2.0.0 bbPress (r2746)
  *
  * @param int $forum_id Optional. Forum id
@@ -839 +840 @@
  * Mark the forum as public
  *
- * @since bbPress (r2746)
+ * @since 2.0.0 bbPress (r2746)
  *
  * @param int $forum_id Optional. Forum id
@@ -897 +898 @@
  * Mark the forum as private
  *
- * @since bbPress (r2746)
+ * @since 2.0.0 bbPress (r2746)
  *
  * @param int $forum_id Optional. Forum id
@@ -947 +948 @@
  * Mark the forum as hidden
  *
- * @since bbPress (r2996)
+ * @since 2.0.0 bbPress (r2996)
  *
  * @param int $forum_id Optional. Forum id
@@ -997 +998 @@
  * Recaches the private and hidden forums
  *
- * @since bbPress (r5017)
+ * @since 2.4.0 bbPress (r5017)
  *
  * @uses delete_option() to delete private and hidden forum pointers
@@ -1060 +1061 @@
  * Remove a deleted forum from all users' subscriptions
  *
- * @since bbPress (r5156)
+ * @since 2.5.0 bbPress (r5156)
  *
  * @param int $forum_id Get the forum ID to remove
@@ -1102 +1103 @@
  * Bump the total topic count of a forum
  *
- * @since bbPress (r3825)
+ * @since 2.1.0 bbPress (r3825)
  *
  * @param int $forum_id Optional. Forum id.
@@ -1160 +1161 @@
  * Bump the total hidden topic count of a forum
  *
- * @since bbPress (r3825)
+ * @since 2.1.0 bbPress (r3825)
  *
  * @param int $forum_id Optional. Forum id.
@@ -1193 +1194 @@
  * Bump the total topic count of a forum
  *
- * @since bbPress (r3825)
+ * @since 2.1.0 bbPress (r3825)
  *
  * @param int $forum_id Optional. Forum id.
@@ -1486 +1487 @@
  * Update the forum sub-forum count
  *
- * @since bbPress (r2625)
+ * @since 2.0.0 bbPress (r2625)
  *
  * @param int $forum_id Optional. Forum id
@@ -1509 +1510 @@
  * Adjust the total topic count of a forum
  *
- * @since bbPress (r2464)
+ * @since 2.0.0 bbPress (r2464)
  *
  * @param int $forum_id Optional. Forum id or topic id. It is checked whether it
@@ -1554 +1555 @@
  * spammed and pending topics)
  *
- * @since bbPress (r2888)
+ * @since 2.0.0 bbPress (r2888)
  *
  * @param int $forum_id Optional. Topic id to update
@@ -1607 +1608 @@
  * Adjust the total reply count of a forum
  *
- * @since bbPress (r2464)
+ * @since 2.0.0 bbPress (r2464)
  *
  * @param int $forum_id Optional. Forum id or topic id. It is checked whether it
@@ -1664 +1665 @@
  * but is necessary to keep everything accurate.
  *
- * @since bbPress (r2908)
+ * @since 2.0.0 bbPress (r2908)
  *
  * @param array $args Supports these arguments:
@@ -1731 +1732 @@
  * Get forum mods for a specific forum ID
  *
- * @since bbPress (r5836)
+ * @since 2.6.0 bbPress (r5836)
  *
  * @param int $forum_id
@@ -1748 +1749 @@
  * Get forum mods for a specific forum ID
  *
- * @since bbPress (r4165)
+ * @since 2.2.0 bbPress (r4165)
  *
  * @param int    $forum_id
@@ -1768 +1769 @@
  * Return an associative array of available topic statuses
  *
- * @since bbPress (r5059)
+ * @since 2.4.0 bbPress (r5059)
  *
  * @return array
@@ -1782 +1783 @@
  * Return an associative array of forum types
  *
- * @since bbPress (r5059)
+ * @since 2.4.0 bbPress (r5059)
  *
  * @return array
@@ -1796 +1797 @@
  * Return an associative array of forum visibility
  *
- * @since bbPress (r5059)
+ * @since 2.4.0 bbPress (r5059)
  *
  * @return array
@@ -1815 +1816 @@
  * Only hidden forum ids are returned. Public and private ids are not.
  *
- * @since bbPress (r3007)
+ * @since 2.0.0 bbPress (r3007)
  *
  * @uses get_option() Returns the unserialized array of hidden forum ids
@@ -1832 +1833 @@
  * Only private forum ids are returned. Public and hidden ids are not.
  *
- * @since bbPress (r3007)
+ * @since 2.0.0 bbPress (r3007)
  *
  * @uses get_option() Returns the unserialized array of private forum ids
@@ -1848 +1849 @@
  * from a query.
  *
- * @since bbPress (r3291)
+ * @since 2.0.0 bbPress (r3291)
  *
  * @param string Optional. The type of value to return. (string|array|meta_query)
@@ -1934 +1935 @@
  * plugins that might be doing their own queries.
  *
- * @since bbPress (r3291)
+ * @since 2.0.0 bbPress (r3291)
  *
  * @param WP_Query $posts_query
@@ -2039 +2040 @@
  * Only topics with published and closed statuses are returned
  *
- * @since bbPress (r2908)
+ * @since 2.0.0 bbPress (r2908)
  *
  * @param int $forum_id Forum id
@@ -2058 +2059 @@
  * Only forums with published status are returned
  *
- * @since bbPress (r2908)
+ * @since 2.0.0 bbPress (r2908)
  *
  * @param int $forum_id Forum id
@@ -2076 +2077 @@
  * Callback to sort forum ID's based on last active time
  *
- * @since bbPress (r3789)
+ * @since 2.1.0 bbPress (r3789)
+ *
  * @param int $a First forum ID to compare
  * @param int $b Second forum ID to compare
@@ -2090 +2092 @@
  * Returns the forum's last reply id
  *
- * @since bbPress (r2908)
+ * @since 2.0.0 bbPress (r2908)
  *
  * @param int $forum_id Forum id
@@ -2136 +2138 @@
  * the user can't view it, then sets a 404
  *
- * @since bbPress (r2996)
+ * @since 2.0.0 bbPress (r2996)
  *
  * @uses current_user_can() To check if the current user can read private forums
@@ -2191 +2193 @@
  * the user can't view it, then sets a 404
  *
- * @since bbPress (r2996)
+ * @since 2.0.0 bbPress (r2996)
  *
  * @uses current_user_can() To check if the current user can read private forums
@@ -2247 +2249 @@
  * Redirect if unathorized user is attempting to edit a forum
  *
- * @since bbPress (r3607)
+ * @since 2.1.0 bbPress (r3607)
  *
  * @uses bbp_is_forum_edit()
@@ -2271 +2273 @@
  * Delete all topics (and their replies) for a specific forum ID
  *
- * @since bbPress (r3668)
+ * @since 2.1.0 bbPress (r3668)
  *
  * @param int $forum_id
@@ -2320 +2322 @@
  * Trash all topics inside a forum
  *
- * @since bbPress (r3668)
+ * @since 2.1.0 bbPress (r3668)
  *
  * @param int $forum_id
@@ -2388 +2390 @@
  * Trash all topics inside a forum
  *
- * @since bbPress (r3668)
+ * @since 2.1.0 bbPress (r3668)
  *
  * @param int $forum_id
@@ -2433 +2435 @@
  * a forum that is being deleted.
  *
- * @since bbPress (r3668)
+ * @since 2.1.0 bbPress (r3668)
+ *
  * @uses bbp_get_forum_id() To get the forum id
  * @uses bbp_is_forum() To check if the passed id is a forum
@@ -2455 +2458 @@
  * a forum that is being trashed.
  *
- * @since bbPress (r3668)
+ * @since 2.1.0 bbPress (r3668)
+ *
  * @uses bbp_get_forum_id() To get the forum id
  * @uses bbp_is_forum() To check if the passed id is a forum
@@ -2473 +2477 @@
  * Called before untrashing a forum
  *
- * @since bbPress (r3668)
+ * @since 2.1.0 bbPress (r3668)
+ *
  * @uses bbp_get_forum_id() To get the forum id
  * @uses bbp_is_forum() To check if the passed id is a forum
@@ -2493 +2498 @@
  * Called after deleting a forum
  *
- * @since bbPress (r3668)
+ * @since 2.1.0 bbPress (r3668)
+ *
  * @uses bbp_get_forum_id() To get the forum id
  * @uses bbp_is_forum() To check if the passed id is a forum
@@ -2511 +2517 @@
  * Called after trashing a forum
  *
- * @since bbPress (r3668)
+ * @since 2.1.0 bbPress (r3668)
+ *
  * @uses bbp_get_forum_id() To get the forum id
  * @uses bbp_is_forum() To check if the passed id is a forum
@@ -2529 +2536 @@
  * Called after untrashing a forum
  *
- * @since bbPress (r3668)
+ * @since 2.1.0 bbPress (r3668)
+ *
  * @uses bbp_get_forum_id() To get the forum id
  * @uses bbp_is_forum() To check if the passed id is a forum