Changeset 5951 for trunk/src/includes/topics/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/topics/functions.php (modified) (48 diffs)

trunk/src/includes/topics/functions.php

@@ -17 +17 @@
  * for the topic to function properly.
  *
- * @since bbPress (r3349)
+ * @since 2.0.0 bbPress (r3349)
  *
  * @uses bbp_parse_args()
@@ -936 +936 @@
  * function can be costly to run but is necessary to keep everything accurate.
  *
- * @since bbPress (r2800)
+ * @since 2.0.0 bbPress (r2800)
+ *
  * @param int $topic_id Topic id
  * @param string $last_active_time Optional. Last active time
@@ -1140 +1141 @@
  * Handles the front end merge topic submission
  *
- * @since bbPress (r2756)
+ * @since 2.0.0 bbPress (r2756)
  *
  * @param string $action The requested action to compare this function to
@@ -1394 +1395 @@
  * and their forums.
  *
- * @since bbPress (r2756)
+ * @since 2.0.0 bbPress (r2756)
  *
  * @param int $destination_topic_id Destination topic id
@@ -1437 +1438 @@
  * Handles the front end split topic submission
  *
- * @since bbPress (r2756)
+ * @since 2.0.0 bbPress (r2756)
  *
  * @param string $action The requested action to compare this function to
@@ -1774 +1775 @@
  * and their forums.
  *
- * @since bbPress (r2756)
+ * @since 2.0.0 bbPress (r2756)
  *
  * @param int $from_reply_id From reply id
@@ -1814 +1815 @@
  * Handles the front end tag management (renaming, merging, destroying)
  *
- * @since bbPress (r2768)
+ * @since 2.0.0 bbPress (r2768)
  *
  * @param string $action The requested action to compare this function to
@@ -2005 +2006 @@
  * Return an associative array of available topic statuses
  *
- * @since bbPress (r5059)
+ * @since 2.4.0 bbPress (r5059)
  *
  * @return array
@@ -2022 +2023 @@
  * Return an associative array of topic sticky types
  *
- * @since bbPress (r5059)
+ * @since 2.4.0 bbPress (r5059)
  *
  * @return array
@@ -2039 +2040 @@
  * Return sticky topics of a forum
  *
- * @since bbPress (r2592)
+ * @since 2.0.0 bbPress (r2592)
  *
  * @param int $forum_id Optional. If not passed, super stickies are returned.
@@ -2057 +2058 @@
  * Return topics stuck to front page of the forums
  *
- * @since bbPress (r2592)
+ * @since 2.0.0 bbPress (r2592)
  *
  * @uses get_option() To get super sticky topics
@@ -2076 +2077 @@
  * sticking/unsticking and trashing/untrashing/deleting of topics
  *
- * @since bbPress (r2727)
+ * @since 2.0.0 bbPress (r2727)
  *
  * @param string $action The requested action to compare this function to
@@ -2258 +2259 @@
  * Remove a deleted topic from all users' favorites
  *
- * @since bbPress (r2652)
+ * @since 2.0.0 bbPress (r2652)
  *
  * @param int $topic_id Get the topic id to remove
@@ -2291 +2292 @@
  * Remove a deleted topic from all users' subscriptions
  *
- * @since bbPress (r2652)
+ * @since 2.0.0 bbPress (r2652)
  *
  * @param int $topic_id Get the topic id to remove
@@ -2333 +2334 @@
  * Bump the total reply count of a topic
  *
- * @since bbPress (r3825)
+ * @since 2.1.0 bbPress (r3825)
  *
  * @param int $topic_id   Optional. Topic id.
@@ -2366 +2367 @@
  * Bump the total hidden reply count of a topic
  *
- * @since bbPress (r3825)
+ * @since 2.1.0 bbPress (r3825)
  *
  * @param int $topic_id   Optional. Topic id.
@@ -2401 +2402 @@
  * Update the topic's forum id
  *
- * @since bbPress (r2855)
+ * @since 2.0.0 bbPress (r2855)
  *
  * @param int $topic_id Optional. Topic id to update
@@ -2438 +2439 @@
  * Update the topic's topic id
  *
- * @since bbPress (r2954)
+ * @since 2.0.0 bbPress (r2954)
  *
  * @param int $topic_id Optional. Topic id to update
@@ -2457 +2458 @@
  * Adjust the total reply count of a topic
  *
- * @since bbPress (r2467)
+ * @since 2.0.0 bbPress (r2467)
  *
  * @param int $topic_id Optional. Topic id to update
@@ -2496 +2497 @@
  * spammed and pending replies)
  *
- * @since bbPress (r2740)
+ * @since 2.0.0 bbPress (r2740)
  *
  * @param int $topic_id Optional. Topic id to update
@@ -2542 +2543 @@
  * Update the topic with the last active post ID
  *
- * @since bbPress (r2888)
+ * @since 2.0.0 bbPress (r2888)
  *
  * @param int $topic_id Optional. Topic id to update
@@ -2626 +2627 @@
  * Update the topic with the most recent reply ID
  *
- * @since bbPress (r2625)
+ * @since 2.0.0 bbPress (r2625)
  *
  * @param int $topic_id Optional. Topic id to update
@@ -2674 +2675 @@
  * Adjust the total voice count of a topic
  *
- * @since bbPress (r2567)
+ * @since 2.0.0 bbPress (r2567)
  *
  * @param int $topic_id Optional. Topic id to update
@@ -2715 +2716 @@
  * Adjust the total anonymous reply count of a topic
  *
- * @since bbPress (r2567)
+ * @since 2.0.0 bbPress (r2567)
  *
  * @param int $topic_id Optional. Topic id to update
@@ -2755 +2756 @@
  * Update the revision log of the topic
  *
- * @since bbPress (r2782)
+ * @since 2.0.0 bbPress (r2782)
  *
  * @param array $args Supports these args:
@@ -2797 +2798 @@
  * Closes a topic
  *
- * @since bbPress (r2740)
+ * @since 2.0.0 bbPress (r2740)
  *
  * @param int $topic_id Topic id
@@ -2867 +2868 @@
  * Opens a topic
  *
- * @since bbPress (r2740)
+ * @since 2.0.0 bbPress (r2740)
  *
  * @param int $topic_id Topic id
@@ -2937 +2938 @@
  * Marks a topic as spam
  *
- * @since bbPress (r2740)
+ * @since 2.0.0 bbPress (r2740)
  *
  * @param int $topic_id Topic id
@@ -2990 +2991 @@
  * Usually you'll want to do this before the topic itself is marked as spam.
  *
- * @since bbPress (r5405)
+ * @since 2.6.0 bbPress (r5405)
  *
  * @param int $topic_id
@@ -3037 +3038 @@
  * Usually you'll want to do this before the topic itself is marked as spam.
  *
- * @since bbPress (r5405)
+ * @since 2.6.0 bbPress (r5405)
  *
  * @param int $topic_id
@@ -3074 +3075 @@
  * Unspams a topic
  *
- * @since bbPress (r2740)
+ * @since 2.0.0 bbPress (r2740)
  *
  * @param int $topic_id Topic id
@@ -3134 +3135 @@
  * Usually you'll want to do this after the topic is unspammed.
  *
- * @since bbPress (r5405)
+ * @since 2.6.0 bbPress (r5405)
  *
  * @param int $topic_id
@@ -3169 +3170 @@
  * Usually you'll want to do this before the topic itself is unmarked as spam.
  *
- * @since bbPress (r5405)
+ * @since 2.6.0 bbPress (r5405)
  *
  * @param int $topic_id
@@ -3192 +3193 @@
  * Sticks a topic to a forum or front
  *
- * @since bbPress (r2754)
+ * @since 2.0.0 bbPress (r2754)
  *
  * @param int $topic_id Optional. Topic id
@@ -3254 +3255 @@
  * Approves a pending topic
  *
- * @since bbPress (r5503)
+ * @since 2.6.0 bbPress (r5503)
  *
  * @param int $topic_id Topic id
@@ -3301 +3302 @@
  * Unapproves a topic
  *
- * @since bbPress (r5503)
+ * @since 2.6.0 bbPress (r5503)
  *
  * @param int $topic_id Topic id
@@ -3347 +3348 @@
  * Unsticks a topic both from front and it's forum
  *
- * @since bbPress (r2754)
+ * @since 2.0.0 bbPress (r2754)
  *
  * @param int $topic_id Optional. Topic id
@@ -3426 +3427 @@
  * Usually you'll want to do this before the topic itself is deleted.
  *
- * @since bbPress (r5405)
+ * @since 2.6.0 bbPress (r5405)
  *
  * @param int $topic_id
@@ -3488 +3489 @@
  * Usually you'll want to do this before the topic itself is marked as spam.
  *
- * @since bbPress (r5405)
+ * @since 2.6.0 bbPress (r5405)
  *
  * @param int $topic_id
@@ -3554 +3555 @@
  * Usually you'll want to do this after the topic is unspammed.
  *
- * @since bbPress (r5405)
+ * @since 2.6.0 bbPress (r5405)
  *
  * @param int $topic_id
@@ -3642 +3643 @@
  * Return the topics per page setting
  *
- * @since bbPress (r3540)
+ * @since 2.0.0 bbPress (r3540)
  *
  * @param int $default Default replies per page (15)
@@ -3666 +3667 @@
  * Return the topics per RSS page setting
  *
- * @since bbPress (r3540)
+ * @since 2.0.0 bbPress (r3540)
  *
  * @param int $default Default replies per page (25)
@@ -3692 +3693 @@
  * Get topic tags for a specific topic ID
  *
- * @since bbPress (r5836)
+ * @since 2.6.0 bbPress (r5836)
  *
  * @param int $topic_id
@@ -3709 +3710 @@
  * Get topic tags for a specific topic ID
  *
- * @since bbPress (r4165)
+ * @since 2.2.0 bbPress (r4165)
  *
  * @param int    $topic_id
@@ -3729 +3730 @@
  * Check if autoembeds are enabled and hook them in if so
  *
- * @since bbPress (r3752)
+ * @since 2.1.0 bbPress (r3752)
+ *
  * @global WP_Embed $wp_embed
  */
@@ -3745 +3747 @@
  * Output an RSS2 feed of topics, based on the query passed.
  *
- * @since bbPress (r3171)
+ * @since 2.0.0 bbPress (r3171)
  *
  * @uses bbp_version()
@@ -3849 +3851 @@
  * Redirect if unathorized user is attempting to edit a topic
  *
- * @since bbPress (r3605)
+ * @since 2.1.0 bbPress (r3605)
  *
  * @uses bbp_is_topic_edit()
@@ -3873 +3875 @@
  * Redirect if unathorized user is attempting to edit a topic tag
  *
- * @since bbPress (r3605)
+ * @since 2.1.0 bbPress (r3605)
  *
  * @uses bbp_is_topic_tag_edit()