Improve the `@param` docs for `src/includes/theme.php` and `src/includes/update.php`.

See #30224.

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


git-svn-id: http://core.svn.wordpress.org/trunk@30662 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Scott Taylor 2014-11-30 22:44:22 +00:00
parent 9a8be964b6
commit d097e7cf83
3 changed files with 8 additions and 7 deletions

View File

@ -871,7 +871,7 @@ function validate_current_theme() {
* *
* @since 3.1.0 * @since 3.1.0
* *
* @return array Theme modifications. * @return array|null Theme modifications.
*/ */
function get_theme_mods() { function get_theme_mods() {
$theme_slug = get_option( 'stylesheet' ); $theme_slug = get_option( 'stylesheet' );
@ -1364,7 +1364,7 @@ body.custom-background { <?php echo trim( $style ); ?> }
* *
* @since 3.0.0 * @since 3.0.0
* *
* @param mixed $stylesheet Optional. Stylesheet name or array thereof, relative to theme root. * @param array|string $stylesheet Optional. Stylesheet name or array thereof, relative to theme root.
* Defaults to 'editor-style.css' * Defaults to 'editor-style.css'
*/ */
function add_editor_style( $stylesheet = 'editor-style.css' ) { function add_editor_style( $stylesheet = 'editor-style.css' ) {
@ -1700,7 +1700,7 @@ function get_theme_support( $feature ) {
* @since 3.0.0 * @since 3.0.0
* @see add_theme_support() * @see add_theme_support()
* @param string $feature the feature being added * @param string $feature the feature being added
* @return bool Whether feature was removed. * @return null|bool Whether feature was removed.
*/ */
function remove_theme_support( $feature ) { function remove_theme_support( $feature ) {
// Blacklist: for internal registrations not used directly by themes. // Blacklist: for internal registrations not used directly by themes.
@ -1715,6 +1715,7 @@ function remove_theme_support( $feature ) {
* *
* @access private * @access private
* @since 3.1.0 * @since 3.1.0
* @param string $feature
*/ */
function _remove_theme_support( $feature ) { function _remove_theme_support( $feature ) {
global $_wp_theme_features; global $_wp_theme_features;

View File

@ -18,7 +18,7 @@
* *
* @param array $extra_stats Extra statistics to report to the WordPress.org API. * @param array $extra_stats Extra statistics to report to the WordPress.org API.
* @param bool $force_check Whether to bypass the transient cache and force a fresh update check. Defaults to false, true if $extra_stats is set. * @param bool $force_check Whether to bypass the transient cache and force a fresh update check. Defaults to false, true if $extra_stats is set.
* @return mixed Returns null if update is unsupported. Returns false if check is too soon. * @return null|false Returns null if update is unsupported. Returns false if check is too soon.
*/ */
function wp_version_check( $extra_stats = array(), $force_check = false ) { function wp_version_check( $extra_stats = array(), $force_check = false ) {
if ( defined('WP_INSTALLING') ) if ( defined('WP_INSTALLING') )
@ -180,7 +180,7 @@ function wp_version_check( $extra_stats = array(), $force_check = false ) {
* @uses $wp_version Used to notify the WordPress version. * @uses $wp_version Used to notify the WordPress version.
* *
* @param array $extra_stats Extra statistics to report to the WordPress.org API. * @param array $extra_stats Extra statistics to report to the WordPress.org API.
* @return mixed Returns null if update is unsupported. Returns false if check is too soon. * @return false|null Returns null if update is unsupported. Returns false if check is too soon.
*/ */
function wp_update_plugins( $extra_stats = array() ) { function wp_update_plugins( $extra_stats = array() ) {
include( ABSPATH . WPINC . '/version.php' ); // include an unmodified $wp_version include( ABSPATH . WPINC . '/version.php' ); // include an unmodified $wp_version
@ -334,7 +334,7 @@ function wp_update_plugins( $extra_stats = array() ) {
* @uses $wp_version Used to notify the WordPress version. * @uses $wp_version Used to notify the WordPress version.
* *
* @param array $extra_stats Extra statistics to report to the WordPress.org API. * @param array $extra_stats Extra statistics to report to the WordPress.org API.
* @return mixed Returns null if update is unsupported. Returns false if check is too soon. * @return false|null Returns null if update is unsupported. Returns false if check is too soon.
*/ */
function wp_update_themes( $extra_stats = array() ) { function wp_update_themes( $extra_stats = array() ) {
include( ABSPATH . WPINC . '/version.php' ); // include an unmodified $wp_version include( ABSPATH . WPINC . '/version.php' ); // include an unmodified $wp_version

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.1-beta2-30671'; $wp_version = '4.1-beta2-30672';
/** /**
* 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.