Changeset 5951 for trunk/src/includes/replies/template.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/replies/template.php (modified) (105 diffs)

trunk/src/includes/replies/template.php

@@ -16 +16 @@
  * Return the unique id of the custom post type for replies
  *
- * @since bbPress (r2857)
+ * @since 2.0.0 bbPress (r2857)
  *
  * @uses bbp_get_reply_post_type() To get the reply post type
@@ -26 +26 @@
      * Return the unique id of the custom post type for replies
      *
-     * @since bbPress (r2857)
+     * @since 2.0.0 bbPress (r2857)
      *
      * @uses apply_filters() Calls 'bbp_get_forum_post_type' with the forum
@@ -39 +39 @@
  * Return array of labels used by the reply post type
  *
- * @since bbPress (r5129)
+ * @since 2.5.0 bbPress (r5129)
  *
  * @return array
@@ -66 +66 @@
  * Return array of reply post type rewrite settings
  *
- * @since bbPress (r5129)
+ * @since 2.5.0 bbPress (r5129)
  *
  * @return array
@@ -80 +80 @@
  * Return array of features the reply post type supports
  *
- * @since bbPress (rx5129)
+ * @since 2.5.0 bbPress (r5129)
  *
  * @return array
@@ -97 +97 @@
  * The main reply loop. WordPress makes this easy for us
  *
- * @since bbPress (r2553)
+ * @since 2.0.0 bbPress (r2553)
  *
  * @param array $args All the arguments supported by {@link WP_Query}
@@ -286 +286 @@
  * Whether there are more replies available in the loop
  *
- * @since bbPress (r2553)
+ * @since 2.0.0 bbPress (r2553)
  *
  * @uses WP_Query bbPress::reply_query::have_posts() To check if there are more
@@ -308 +308 @@
  * Loads up the current reply in the loop
  *
- * @since bbPress (r2553)
+ * @since 2.0.0 bbPress (r2553)
  *
  * @uses WP_Query bbPress::reply_query::the_post() To get the current reply
@@ -320 +320 @@
  * Output reply id
  *
- * @since bbPress (r2553)
+ * @since 2.0.0 bbPress (r2553)
  *
  * @param $reply_id Optional. Used to check emptiness
@@ -331 +331 @@
      * Return the id of the reply in a replies loop
      *
-     * @since bbPress (r2553)
+     * @since 2.0.0 bbPress (r2553)
      *
      * @param $reply_id Optional. Used to check emptiness
@@ -381 +381 @@
  * Gets a reply
  *
- * @since bbPress (r2787)
+ * @since 2.0.0 bbPress (r2787)
  *
  * @param int|object $reply reply id or reply object
@@ -424 +424 @@
  * Output the link to the reply in the reply loop
  *
- * @since bbPress (r2553)
+ * @since 2.0.0 bbPress (r2553)
  *
  * @param int $reply_id Optional. Reply id
@@ -435 +435 @@
      * Return the link to the reply
      *
-     * @since bbPress (r2553)
+     * @since 2.0.0 bbPress (r2553)
      *
      * @param int $reply_id Optional. Reply id
@@ -452 +452 @@
  * Output the paginated url to the reply in the reply loop
  *
- * @since bbPress (r2679)
+ * @since 2.0.0 bbPress (r2679)
  *
  * @param int $reply_id Optional. Reply id
@@ -463 +463 @@
      * Return the paginated url to the reply in the reply loop
      *
-     * @since bbPress (r2679)
+     * @since 2.0.0 bbPress (r2679)
      *
      * @param int $reply_id Optional. Reply id
@@ -526 +526 @@
  * Output the title of the reply
  *
- * @since bbPress (r2553)
+ * @since 2.0.0 bbPress (r2553)
  *
  * @param int $reply_id Optional. Reply id
@@ -538 +538 @@
      * Return the title of the reply
      *
-     * @since bbPress (r2553)
+     * @since 2.0.0 bbPress (r2553)
      *
      * @param int $reply_id Optional. Reply id
@@ -556 +556 @@
      * Get empty reply title fallback.
      *
-     * @since bbPress (r5177)
+     * @since 2.5.0 bbPress (r5177)
      *
      * @param string $post_title Required. Reply Title
@@ -583 +583 @@
  * Output the content of the reply
  *
- * @since bbPress (r2553)
+ * @since 2.0.0 bbPress (r2553)
  *
  * @param int $reply_id Optional. reply id
@@ -594 +594 @@
      * Return the content of the reply
      *
-     * @since bbPress (r2780)
+     * @since 2.0.0 bbPress (r2780)
      *
      * @param int $reply_id Optional. reply id
@@ -621 +621 @@
  * Output the excerpt of the reply
  *
- * @since bbPress (r2751)
+ * @since 2.0.0 bbPress (r2751)
  *
  * @param int $reply_id Optional. Reply id
@@ -633 +633 @@
      * Return the excerpt of the reply
      *
-     * @since bbPress (r2751)
+     * @since 2.0.0 bbPress (r2751)
      *
      * @param int $reply_id Optional. Reply id
@@ -674 +674 @@
  * Output the post date and time of a reply
  *
- * @since bbPress (r4155)
+ * @since 2.2.0 bbPress (r4155)
  *
  * @param int $reply_id Optional. Reply id.
@@ -687 +687 @@
      * Return the post date and time of a reply
      *
-     * @since bbPress (r4155)
+     * @since 2.2.0 bbPress (r4155)
      *
      * @param int $reply_id Optional. Reply id.
@@ -720 +720 @@
  * Append revisions to the reply content
  *
- * @since bbPress (r2782)
+ * @since 2.0.0 bbPress (r2782)
  *
  * @param string $content Optional. Content to which we need to append the revisions to
@@ -745 +745 @@
  * Output the revision log of the reply
  *
- * @since bbPress (r2782)
+ * @since 2.0.0 bbPress (r2782)
  *
  * @param int $reply_id Optional. Reply id
@@ -756 +756 @@
      * Return the formatted revision log of the reply
      *
-     * @since bbPress (r2782)
+     * @since 2.0.0 bbPress (r2782)
      *
      * @param int $reply_id Optional. Reply id
@@ -827 +827 @@
          * Return the raw revision log of the reply
          *
-         * @since bbPress (r2782)
+         * @since 2.0.0 bbPress (r2782)
          *
          * @param int $reply_id Optional. Reply id
@@ -847 +847 @@
  * Return the revisions of the reply
  *
- * @since bbPress (r2782)
+ * @since 2.0.0 bbPress (r2782)
  *
  * @param int $reply_id Optional. Reply id
@@ -866 +866 @@
  * Return the revision count of the reply
  *
- * @since bbPress (r2782)
+ * @since 2.0.0 bbPress (r2782)
  *
  * @param int $reply_id Optional. Reply id
@@ -885 +885 @@
  * Output the status of the reply
  *
- * @since bbPress (r2667)
+ * @since 2.0.0 bbPress (r2667)
  *
  * @param int $reply_id Optional. Reply id
@@ -896 +896 @@
      * Return the status of the reply
      *
-     * @since bbPress (r2667)
+     * @since 2.0.0 bbPress (r2667)
      *
      * @param int $reply_id Optional. Reply id
@@ -912 +912 @@
  * Is the reply not spam or deleted?
  *
- * @since bbPress (r3496)
+ * @since 2.0.0 bbPress (r3496)
  *
  * @param int $reply_id Optional. Topic id
@@ -927 +927 @@
  * Is the reply marked as spam?
  *
- * @since bbPress (r2740)
+ * @since 2.0.0 bbPress (r2740)
  *
  * @param int $reply_id Optional. Reply id
@@ -942 +942 @@
  * Is the reply trashed?
  *
- * @since bbPress (r2884)
+ * @since 2.0.0 bbPress (r2884)
  *
  * @param int $reply_id Optional. Topic id
@@ -957 +957 @@
  * Is the reply pending?
  *
- * @since bbPress (r5507)
+ * @since 2.6.0 bbPress (r5507)
  *
  * @param int $reply_id Optional. Topic id
@@ -973 +973 @@
  * Is the reply private?
  *
- * @since bbPress (r5507)
+ * @since 2.6.0 bbPress (r5507)
  *
  * @param int $reply_id Optional. Topic id
@@ -989 +989 @@
  * Is the reply by an anonymous user?
  *
- * @since bbPress (r2753)
+ * @since 2.0.0 bbPress (r2753)
  *
  * @param int $reply_id Optional. Reply id
@@ -1019 +1019 @@
  * Output the author of the reply
  *
- * @since bbPress (r2667)
- * @deprecated bbPress (r5119)
+ * @since 2.0.0 bbPress (r2667)
+ *
+ * @deprecated 2.5.0 bbPress (r5119)
  *
  * @param int $reply_id Optional. Reply id
@@ -1033 +1034 @@
      * Return the author of the reply
      *
-     * @since bbPress (r2667)
-     * @deprecated bbPress (r5119)
+     * @since 2.0.0 bbPress (r2667)
+     *
+     * @deprecated 2.5.0 bbPress (r5119)
      *
      * @param int $reply_id Optional. Reply id
@@ -1061 +1063 @@
  * Output the author ID of the reply
  *
- * @since bbPress (r2667)
+ * @since 2.0.0 bbPress (r2667)
  *
  * @param int $reply_id Optional. Reply id
@@ -1072 +1074 @@
      * Return the author ID of the reply
      *
-     * @since bbPress (r2667)
+     * @since 2.0.0 bbPress (r2667)
      *
      * @param int $reply_id Optional. Reply id
@@ -1091 +1093 @@
  * Output the author display_name of the reply
  *
- * @since bbPress (r2667)
+ * @since 2.0.0 bbPress (r2667)
  *
  * @param int $reply_id Optional. Reply id
@@ -1102 +1104 @@
      * Return the author display_name of the reply
      *
-     * @since bbPress (r2667)
+     * @since 2.0.0 bbPress (r2667)
      *
      * @param int $reply_id Optional. Reply id
@@ -1153 +1155 @@
  * Output the author avatar of the reply
  *
- * @since bbPress (r2667)
+ * @since 2.0.0 bbPress (r2667)
  *
  * @param int $reply_id Optional. Reply id
@@ -1165 +1167 @@
      * Return the author avatar of the reply
      *
-     * @since bbPress (r2667)
+     * @since 2.0.0 bbPress (r2667)
      *
      * @param int $reply_id Optional. Reply id
@@ -1198 +1200 @@
  * Output the author link of the reply
  *
- * @since bbPress (r2717)
+ * @since 2.0.0 bbPress (r2717)
  *
  * @param array $args Optional. If it is an integer, it is used as reply id.
@@ -1209 +1211 @@
      * Return the author link of the reply
      *
-     * @since bbPress (r2717)
+     * @since 2.0.0 bbPress (r2717)
      *
      * @param array $args Optional. If an integer, it is used as reply id.
@@ -1308 +1310 @@
  * Output the author url of the reply
  *
- * @since bbPress (r2667)
+ * @since 2.0.0 bbPress (r2667)
  *
  * @param int $reply_id Optional. Reply id
@@ -1319 +1321 @@
      * Return the author url of the reply
      *
-     * @since bbPress (r2667)
+     * @since 2.0.0 bbPress (r2667)
      *
      * @param int $reply_id Optional. Reply id
@@ -1352 +1354 @@
  * Output the reply author email address
  *
- * @since bbPress (r3445)
+ * @since 2.0.0 bbPress (r3445)
  *
  * @param int $reply_id Optional. Reply id
@@ -1363 +1365 @@
      * Return the reply author email address
      *
-     * @since bbPress (r3445)
+     * @since 2.0.0 bbPress (r3445)
      *
      * @param int $reply_id Optional. Reply id
@@ -1405 +1407 @@
  * Output the reply author role
  *
- * @since bbPress (r3860)
+ * @since 2.1.0 bbPress (r3860)
  *
  * @param array $args Optional.
@@ -1416 +1418 @@
      * Return the reply author role
      *
-     * @since bbPress (r3860)
+     * @since 2.1.0 bbPress (r3860)
      *
      * @param array $args Optional.
@@ -1455 +1457 @@
  * Output the topic title a reply belongs to
  *
- * @since bbPress (r2553)
+ * @since 2.0.0 bbPress (r2553)
  *
  * @param int $reply_id Optional. Reply id
@@ -1466 +1468 @@
      * Return the topic title a reply belongs to
      *
-     * @since bbPress (r2553)
+     * @since 2.0.0 bbPress (r2553)
      *
      * @param int $reply_id Optional. Reply id
@@ -1486 +1488 @@
  * Output the topic id a reply belongs to
  *
- * @since bbPress (r2553)
+ * @since 2.0.0 bbPress (r2553)
  *
  * @param int $reply_id Optional. Reply id
@@ -1497 +1499 @@
      * Return the topic id a reply belongs to
      *
-     * @since bbPress (r2553)
+     * @since 2.0.0 bbPress (r2553)
      *
      * @param int $reply_id Optional. Reply id
@@ -1527 +1529 @@
  * Output the forum id a reply belongs to
  *
- * @since bbPress (r2679)
+ * @since 2.0.0 bbPress (r2679)
  *
  * @param int $reply_id Optional. Reply id
@@ -1538 +1540 @@
      * Return the forum id a reply belongs to
      *
-     * @since bbPress (r2679)
+     * @since 2.0.0 bbPress (r2679)
      *
      * @param int $reply_id Optional. Reply id
@@ -1567 +1569 @@
  * Output the reply's ancestor reply id
  *
- * @since bbPress (r4944)
+ * @since 2.4.0 bbPress (r4944)
  *
  * @param int $reply_id Optional. Reply id
@@ -1578 +1580 @@
      * Return the reply's ancestor reply id
      *
-     * @since bbPress (r4944)
+     * @since 2.4.0 bbPress (r4944)
      *
      * @param in $reply_id Reply id
@@ -1606 +1608 @@
  * Output the reply to id of a reply
  *
- * @since bbPress (r4944)
+ * @since 2.4.0 bbPress (r4944)
  *
  * @param int $reply_id Optional. Reply id
@@ -1617 +1619 @@
      * Return the reply to id of a reply
      *
-     * @since bbPress (r4944)
+     * @since 2.4.0 bbPress (r4944)
      *
      * @param int $reply_id Optional. Reply id
@@ -1645 +1647 @@
  * Output the link for the reply to
  *
- * @since bbPress (r4944)
+ * @since 2.4.0 bbPress (r4944)
  *
  * @param array $args
@@ -1657 +1659 @@
      * Return the link for a reply to a reply
      *
-     * @since bbPress (r4944)
+     * @since 2.4.0 bbPress (r4944)
      *
      * @param array $args Arguments
@@ -1723 +1725 @@
  * Output the reply to a reply cancellation link
  *
- * @since bbPress (r4944)
+ * @since 2.4.0 bbPress (r4944)
  *
  * @uses bbp_get_cancel_reply_to_link() To get the reply cancellation link
@@ -1733 +1735 @@
      * Return the cancellation link for a reply to a reply
      *
-     * @since bbPress (r4944)
+     * @since 2.4.0 bbPress (r4944)
      *
      * @param string $text The cancel text
@@ -1765 +1767 @@
  * Output the numeric position of a reply within a topic
  *
- * @since bbPress (r2984)
+ * @since 2.0.0 bbPress (r2984)
  *
  * @param int $reply_id Optional. Reply id
@@ -1777 +1779 @@
      * Return the numeric position of a reply within a topic
      *
-     * @since bbPress (r2984)
+     * @since 2.0.0 bbPress (r2984)
      *
      * @param int $reply_id Optional. Reply id
@@ -1831 +1833 @@
  * Output admin links for reply
  *
- * @since bbPress (r2667)
+ * @since 2.0.0 bbPress (r2667)
  *
  * @param array $args See {@link bbp_get_reply_admin_links()}
@@ -1842 +1844 @@
      * Return admin links for reply
      *
-     * @since bbPress (r2667)
+     * @since 2.0.0 bbPress (r2667)
      *
      * @param array $args This function supports these arguments:
@@ -1931 +1933 @@
  * Output the edit link of the reply
  *
- * @since bbPress (r2740)
+ * @since 2.0.0 bbPress (r2740)
  *
  * @param array $args See {@link bbp_get_reply_edit_link()}
@@ -1943 +1945 @@
      * Return the edit link of the reply
      *
-     * @since bbPress (r2740)
+     * @since 2.0.0 bbPress (r2740)
      *
      * @param array $args This function supports these arguments:
@@ -1996 +1998 @@
  * Output URL to the reply edit page
  *
- * @since bbPress (r2753)
+ * @since 2.0.0 bbPress (r2753)
  *
  * @param int $reply_id Optional. Reply id
@@ -2007 +2009 @@
      * Return URL to the reply edit page
      *
-     * @since bbPress (r2753)
+     * @since 2.0.0 bbPress (r2753)
      *
      * @param int $reply_id Optional. Reply id
@@ -2049 +2051 @@
  * Output the trash link of the reply
  *
- * @since bbPress (r2740)
+ * @since 2.0.0 bbPress (r2740)
  *
  * @param array $args See {@link bbp_get_reply_trash_link()}
@@ -2061 +2063 @@
      * Return the trash link of the reply
      *
-     * @since bbPress (r2740)
+     * @since 2.0.0 bbPress (r2740)
      *
      * @param array $args This function supports these arguments:
@@ -2125 +2127 @@
  * Output the spam link of the reply
  *
- * @since bbPress (r2740)
+ * @since 2.0.0 bbPress (r2740)
  *
  * @param array $args See {@link bbp_get_reply_spam_link()}
@@ -2137 +2139 @@
      * Return the spam link of the reply
      *
-     * @since bbPress (r2740)
+     * @since 2.0.0 bbPress (r2740)
      *
      * @param array $args This function supports these arguments:
@@ -2188 +2190 @@
  * Output the move link of the reply
  *
- * @since bbPress (r4521)
+ * @since 2.3.0 bbPress (r4521)
  *
  * @param array $args See {@link bbp_get_reply_move_link()}
@@ -2202 +2204 @@
      * Return the move link of the reply
      *
-     * @since bbPress (r4521)
+     * @since 2.3.0 bbPress (r4521)
      *
      * @param array $args This function supports these arguments:
@@ -2256 +2258 @@
  * Output the split link of the topic (but is bundled with each reply)
  *
- * @since bbPress (r2756)
+ * @since 2.0.0 bbPress (r2756)
  *
  * @param array $args See {@link bbp_get_topic_split_link()}
@@ -2270 +2272 @@
      * Return the split link of the topic (but is bundled with each reply)
      *
-     * @since bbPress (r2756)
+     * @since 2.0.0 bbPress (r2756)
      *
      * @param array $args This function supports these arguments:
@@ -2322 +2324 @@
  * Output the approve link of the reply
  *
- * @since bbPress (r5507)
+ * @since 2.6.0 bbPress (r5507)
  *
  * @param array $args See {@link bbp_get_reply_approve_link()}
@@ -2334 +2336 @@
      * Return the approve link of the reply
      *
-     * @since bbPress (r5507)
+     * @since 2.6.0 bbPress (r5507)
      *
      * @param array $args This function supports these args:
@@ -2383 +2385 @@
  * Output the row class of a reply
  *
- * @since bbPress (r2678)
+ * @since 2.0.0 bbPress (r2678)
  *
  * @param int $reply_id Optional. Reply ID
@@ -2395 +2397 @@
      * Return the row class of a reply
      *
-     * @since bbPress (r2678)
+     * @since 2.0.0 bbPress (r2678)
      *
      * @param int $reply_id Optional. Reply ID
@@ -2428 +2430 @@
  * Output the topic pagination count
  *
- * @since bbPress (r2519)
+ * @since 2.0.0 bbPress (r2519)
  *
  * @uses bbp_get_topic_pagination_count() To get the topic pagination count
@@ -2438 +2440 @@
      * Return the topic pagination count
      *
-     * @since bbPress (r2519)
+     * @since 2.0.0 bbPress (r2519)
      *
      * @uses bbp_number_format() To format the number value
@@ -2501 +2503 @@
  * Output topic pagination links
  *
- * @since bbPress (r2519)
+ * @since 2.0.0 bbPress (r2519)
  *
  * @uses bbp_get_topic_pagination_links() To get the topic pagination links
@@ -2511 +2513 @@
      * Return topic pagination links
      *
-     * @since bbPress (r2519)
+     * @since 2.0.0 bbPress (r2519)
      *
      * @uses apply_filters() Calls 'bbp_get_topic_pagination_links' with the
@@ -2532 +2534 @@
  * Output the value of reply content field
  *
- * @since bbPress (r31301)
+ * @since 2.0.0 bbPress (r3130)
  *
  * @uses bbp_get_form_reply_content() To get value of reply content field
@@ -2542 +2544 @@
      * Return the value of reply content field
      *
-     * @since bbPress (r31301)
+     * @since 2.0.0 bbPress (r3130)
      *
      * @uses bbp_is_reply_edit() To check if it's the reply edit page
@@ -2569 +2571 @@
  * Output the value of the reply to field
  *
- * @since bbPress (r4944)
+ * @since 2.4.0 bbPress (r4944)
  *
  * @uses bbp_get_form_reply_to() To get value of the reply to field
@@ -2580 +2582 @@
      * Return the value of reply to field
      *
-     * @since bbPress (r4944)
+     * @since 2.4.0 bbPress (r4944)
      *
      * @uses bbp_get_reply_id() To validate the reply to
@@ -2608 +2610 @@
  * reply belongs to.
  *
- * @since bbPress (r5387)
+ * @since 2.6.0 bbPress (r5387)
  *
  * @param int $reply_id
@@ -2618 +2620 @@
      * Return a select box allowing to pick which topic/reply a reply belongs.
      *
-     * @since bbPress (r5387)
+     * @since 2.6.0 bbPress (r5387)
      *
      * @param int $reply_id
@@ -2692 +2694 @@
  * Output checked value of reply log edit field
  *
- * @since bbPress (r31301)
+ * @since 2.0.0 bbPress (r3130)
  *
  * @uses bbp_get_form_reply_log_edit() To get the reply log edit value
@@ -2702 +2704 @@
      * Return checked value of reply log edit field
      *
-     * @since bbPress (r31301)
+     * @since 2.0.0 bbPress (r3130)
      *
      * @uses apply_filters() Calls 'bbp_get_form_reply_log_edit' with the
@@ -2728 +2730 @@
  * Output the value of the reply edit reason
  *
- * @since bbPress (r31301)
+ * @since 2.0.0 bbPress (r3130)
  *
  * @uses bbp_get_form_reply_edit_reason() To get the reply edit reason value
@@ -2738 +2740 @@
      * Return the value of the reply edit reason
      *
-     * @since bbPress (r31301)
+     * @since 2.0.0 bbPress (r3130)
      *
      * @uses apply_filters() Calls 'bbp_get_form_reply_edit_reason' with the
@@ -2761 +2763 @@
  * Output value reply status dropdown
  *
- * @since bbPress (r5399)
+ * @since 2.6.0 bbPress (r5399)
  *
  * @param $args This function supports these arguments:
@@ -2779 +2781 @@
      * within this function to check available reply statuses.
      *
-     * @since bbPress (r5399)
+     * @since 2.6.0 bbPress (r5399)
      *
      * @param $args This function supports these arguments:
@@ -2850 +2852 @@
  * @see bbp_reply_form_fields()
  *
- * @since bbPress (r5558)
+ * @since 2.6.0 bbPress (r5558)
+ *
  * @return boolean True if is a post request with valid nonce
  */