Changeset 31170

Timestamp:

01/13/2015 12:50:32 AM (10 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.

Location:

trunk/src

Files:

• wp-admin/admin.php (modified) (1 diff)
• wp-cron.php (modified) (1 diff)
• wp-includes/functions.php (modified) (3 diffs)
• wp-includes/general-template.php (modified) (1 diff)
• wp-includes/script-loader.php (modified) (2 diffs)

trunk/src/wp-admin/admin.php

@@ -217 +217 @@
          * Used to call the registered callback for a plugin screen.
          *
-         * @internal
+         * @ignore
          * @since 1.5.0
          */

trunk/src/wp-cron.php

@@ -95 +95 @@
              * Fires scheduled events.
              *
-             * @internal
+             * @ignore
              * @since 2.1.0
              *

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
  *

trunk/src/wp-includes/general-template.php

@@ -717 +717 @@
  * Display title tag with contents.
  *
+ * @ignore
  * @since 4.1.0
  * @access private
- * @internal
  *
  * @see wp_title()

trunk/src/wp-includes/script-loader.php

@@ -832 +832 @@
 
 /**
- * @internal use
+ * Print scripts (internal use only)
+ *
+ * @ignore
  */
 function _print_scripts() {
@@ -998 +1000 @@
 
 /**
- * @internal use
+ * Print styles (internal use only)
+ *
+ * @ignore
  */
 function _print_styles() {