Changeset 5951 for trunk/src/includes/common/formatting.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/common/formatting.php (modified) (13 diffs)

trunk/src/includes/common/formatting.php

@@ -18 +18 @@
  * Allows all users to post links, quotes, code, formatting, lists, and images
  *
- * @since bbPress (r4603)
+ * @since 2.3.0 bbPress (r4603)
  *
  * @return array Associative array of allowed tags and attributes
@@ -77 +77 @@
  * Custom kses filter for forum topics and replies, for filtering incoming data
  *
- * @since bbPress (r4603)
+ * @since 2.3.0 bbPress (r4603)
  *
  * @param string $data Content to filter, expected to be escaped with slashes
@@ -89 +89 @@
  * Custom kses filter for forum topics and replies, for raw data
  *
- * @since bbPress (r4603)
+ * @since 2.3.0 bbPress (r4603)
  *
  * @param string $data Content to filter, expected to not be escaped
@@ -103 +103 @@
  * Filter the topic or reply content and output code and pre tags
  *
- * @since bbPress (r4641)
+ * @since 2.3.0 bbPress (r4641)
  *
  * @param string $content Topic and reply content
@@ -120 +120 @@
  * contains the correct editable content.
  *
- * @since bbPress (r4641)
+ * @since 2.3.0 bbPress (r4641)
  *
  * @param string $content Topic and reply content
@@ -144 +144 @@
  * Filter the content and encode any bad HTML tags
  *
- * @since bbPress (r4641)
+ * @since 2.3.0 bbPress (r4641)
  *
  * @param string $content Topic and reply content
@@ -187 +187 @@
  * Callback to encode the tags in topic or reply content
  *
- * @since bbPress (r4641)
+ * @since 2.3.0 bbPress (r4641)
  *
  * @param array $matches
@@ -223 +223 @@
  * Callback to decode the tags in topic or reply content
  *
- * @since bbPress (r4641)
+ * @since 2.3.0 bbPress (r4641)
  *
  * @param array $matches
@@ -252 +252 @@
  * Callback to replace empty HTML tags in a content string
  *
- * @since bbPress (r4641)
+ * @since 2.3.0 bbPress (r4641)
  *
  * @internal Used by bbp_encode_bad()
@@ -268 +268 @@
  * Callback to replace normal HTML tags in a content string
  *
- * @since bbPress (r4641)
+ * @since 2.3.0 bbPress (r4641)
  *
  * @internal Used by bbp_encode_bad()
@@ -286 +286 @@
  * Catches links so rel=nofollow can be added (on output, not save)
  *
- * @since bbPress (r4865)
+ * @since 2.3.0 bbPress (r4865)
+ *
  * @param string $text Post text
  * @return string $text Text with rel=nofollow added to any links
@@ -297 +298 @@
  * Adds rel=nofollow to a link
  *
- * @since bbPress (r4865)
+ * @since 2.3.0 bbPress (r4865)
+ *
  * @param array $matches
  * @return string $text Link with rel=nofollow added
@@ -318 +320 @@
  * pre and code tags.
  *
- * @since bbPress (r4941)
+ * @since 2.4.0 bbPress (r4941)
  *
  * @param string $text Content to convert URIs.