Changeset 31170 for trunk/src/wp-includes/functions.php

Timestamp:

01/13/2015 12:50:32 AM (11 years ago)

Author:

DrewAPicture

Message:

Ensure we're using the correct @ignore phpDocumentor tag to mark elements that should be skipped when parsing.

Up to this point, various core elements' DocBlocks incorrectly included an @internal tag as a means for skipping the parsing process. When paired with a description (inline or otherwise), @internal is a valid tag meant to provide internal-only context, but not necessarily to skip parsing the entire element.

See #30987.

File:

• trunk/src/wp-includes/functions.php (modified) (3 diffs)

trunk/src/wp-includes/functions.php

@@ -2685 +2685 @@
  * Perform sanity checks on data that shall be encoded to JSON.
  *
- * @see wp_json_encode()
- *
+ * @ignore
  * @since 4.1.0
  * @access private
- * @internal
+ *
+ * @see wp_json_encode()
  *
  * @param mixed $data  Variable (usually an array or object) to encode as JSON.
@@ -2748 +2748 @@
  * Convert a string to UTF-8, so that it can be safely encoded to JSON.
  *
- * @see _wp_json_sanity_check()
- *
+ * @ignore
  * @since 4.1.0
  * @access private
- * @internal
+ *
+ * @see _wp_json_sanity_check()
  *
  * @param string $string The string which is to be converted.
@@ -4321 +4321 @@
  * Return a MySQL expression for selecting the week number based on the start_of_week option.
  *
- * @internal
+ * @ignore
  * @since 3.0.0
  *