From 9b0cf1bd5bc0a56eaff7f13f0fb8511fdecb3cb4 Mon Sep 17 00:00:00 2001
From: "Drew Jaynes (DrewAPicture)" <drewapicture@git.wordpress.org>
Date: Tue, 13 Jan 2015 00:50:32 +0000
Subject: [PATCH] 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.


git-svn-id: https://develop.svn.wordpress.org/trunk@31170 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-admin/admin.php               |  2 +-
 src/wp-cron.php                      |  2 +-
 src/wp-includes/functions.php        | 14 +++++++-------
 src/wp-includes/general-template.php |  2 +-
 src/wp-includes/script-loader.php    |  8 ++++++--
 5 files changed, 16 insertions(+), 12 deletions(-)

diff --git a/src/wp-admin/admin.php b/src/wp-admin/admin.php
index dc2713ff7d..1040995f1b 100644
--- a/src/wp-admin/admin.php
+++ b/src/wp-admin/admin.php
@@ -216,7 +216,7 @@ if ( isset($plugin_page) ) {
 		/**
 		 * Used to call the registered callback for a plugin screen.
 		 *
-		 * @internal
+		 * @ignore
 		 * @since 1.5.0
 		 */
 		do_action( $page_hook );
diff --git a/src/wp-cron.php b/src/wp-cron.php
index 2b965ddf5b..6ce1a3da9a 100644
--- a/src/wp-cron.php
+++ b/src/wp-cron.php
@@ -94,7 +94,7 @@ foreach ( $crons as $timestamp => $cronhooks ) {
 			/**
 			 * Fires scheduled events.
 			 *
-			 * @internal
+			 * @ignore
 			 * @since 2.1.0
 			 *
 			 * @param string $hook Name of the hook that was scheduled to be fired.
diff --git a/src/wp-includes/functions.php b/src/wp-includes/functions.php
index 52759950d7..072d12cfa3 100644
--- a/src/wp-includes/functions.php
+++ b/src/wp-includes/functions.php
@@ -2684,11 +2684,11 @@ function wp_json_encode( $data, $options = 0, $depth = 512 ) {
 /**
  * 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.
  * @param int   $depth Maximum depth to walk through $data. Must be greater than 0.
@@ -2747,11 +2747,11 @@ function _wp_json_sanity_check( $data, $depth ) {
 /**
  * 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.
  * @return string The checked string.
@@ -4320,7 +4320,7 @@ function send_nosniff_header() {
 /**
  * Return a MySQL expression for selecting the week number based on the start_of_week option.
  *
- * @internal
+ * @ignore
  * @since 3.0.0
  *
  * @param string $column Database column.
diff --git a/src/wp-includes/general-template.php b/src/wp-includes/general-template.php
index 080a4ba29e..c7e06a5fd3 100644
--- a/src/wp-includes/general-template.php
+++ b/src/wp-includes/general-template.php
@@ -716,9 +716,9 @@ function get_bloginfo( $show = '', $filter = 'raw' ) {
 /**
  * Display title tag with contents.
  *
+ * @ignore
  * @since 4.1.0
  * @access private
- * @internal
  *
  * @see wp_title()
  */
diff --git a/src/wp-includes/script-loader.php b/src/wp-includes/script-loader.php
index ebac79e947..158499d2f1 100644
--- a/src/wp-includes/script-loader.php
+++ b/src/wp-includes/script-loader.php
@@ -831,7 +831,9 @@ function print_footer_scripts() {
 }
 
 /**
- * @internal use
+ * Print scripts (internal use only)
+ *
+ * @ignore
  */
 function _print_scripts() {
 	global $wp_scripts, $compress_scripts;
@@ -997,7 +999,9 @@ function print_late_styles() {
 }
 
 /**
- * @internal use
+ * Print styles (internal use only)
+ *
+ * @ignore
  */
 function _print_styles() {
 	global $wp_styles, $compress_css;