Upstream
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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.

Built from https://develop.svn.wordpress.org/trunk@31170


git-svn-id: http://core.svn.wordpress.org/trunk@31151 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-01-13 00:51:21 +00:00
parent 632c26d142
commit f2bc30c03f
6 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
wp-admin/admin.php
View File

@ -216,7 +216,7 @@ if ( isset($plugin_page) ) {
/** /**
* Used to call the registered callback for a plugin screen. * Used to call the registered callback for a plugin screen.
* *
* @internal * @ignore
* @since 1.5.0 * @since 1.5.0
*/ */
do_action( $page_hook ); do_action( $page_hook );

2
wp-cron.php
View File

@ -94,7 +94,7 @@ foreach ( $crons as $timestamp => $cronhooks ) {
/** /**
* Fires scheduled events. * Fires scheduled events.
* *
* @internal * @ignore
* @since 2.1.0 * @since 2.1.0
* *
* @param string $hook Name of the hook that was scheduled to be fired. * @param string $hook Name of the hook that was scheduled to be fired.

14
wp-includes/functions.php
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. * Perform sanity checks on data that shall be encoded to JSON.
* *
* @see wp_json_encode() * @ignore
*
* @since 4.1.0 * @since 4.1.0
* @access private * @access private
* @internal *
* @see wp_json_encode()
* *
* @param mixed $data Variable (usually an array or object) to encode as JSON. * @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. * @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. * 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 * @since 4.1.0
* @access private * @access private
* @internal *
* @see _wp_json_sanity_check()
* *
* @param string $string The string which is to be converted. * @param string $string The string which is to be converted.
* @return string The checked string. * @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. * Return a MySQL expression for selecting the week number based on the start_of_week option.
* *
* @internal * @ignore
* @since 3.0.0 * @since 3.0.0
* *
* @param string $column Database column. * @param string $column Database column.

2
wp-includes/general-template.php
View File

@ -716,9 +716,9 @@ function get_bloginfo( $show = '', $filter = 'raw' ) {
/** /**
* Display title tag with contents. * Display title tag with contents.
* *
* @ignore
* @since 4.1.0 * @since 4.1.0
* @access private * @access private
* @internal
* *
* @see wp_title() * @see wp_title()
*/ */

8
wp-includes/script-loader.php
View File

@ -831,7 +831,9 @@ function print_footer_scripts() {
} }
/** /**
* @internal use * Print scripts (internal use only)
*
* @ignore
*/ */
function _print_scripts() { function _print_scripts() {
global $wp_scripts, $compress_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() { function _print_styles() {
global $wp_styles, $compress_css; global $wp_styles, $compress_css;

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.2-alpha-31169'; $wp_version = '4.2-alpha-31170';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.