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
This commit is contained in:
Drew Jaynes (DrewAPicture)
2015-01-13 00:50:32 +00:00
parent 1f9ee350fc
commit 9b0cf1bd5b
5 changed files with 16 additions and 12 deletions

View File

@@ -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.