Fix inline documentation syntax for a few general-purpose functions and hooks added in 4.3.

* `_deprecated_constructor()` See [32989]
* `deprecated_constructor_trigger_error` See [32989]
* `get_main_network_id()` See [32775]
* `wp_post_preview_js()` See [32809]

See #32891.


git-svn-id: https://develop.svn.wordpress.org/trunk@33226 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-07-13 21:34:35 +00:00
parent a38797967a
commit 9bfee68719
1 changed files with 5 additions and 3 deletions

View File

@ -3421,12 +3421,11 @@ function _deprecated_function( $function, $version, $replacement = null ) {
* Similar to _deprecated_function(), but with different strings. Used to
* remove PHP4 style constructors.
*
* The current behavior is to trigger a user error if WP_DEBUG is true.
* The current behavior is to trigger a user error if `WP_DEBUG` is true.
*
* This function is to be used in every PHP4 style constructor method that is deprecated.
*
* @since 4.3.0
*
* @access private
*
* @param string $class The class containing the deprecated constructor.
@ -3447,6 +3446,8 @@ function _deprecated_constructor( $class, $version ) {
/**
* Filter whether to trigger an error for deprecated functions.
*
* `WP_DEBUG` must be true in addition to the filter evaluating to true.
*
* @since 4.3.0
*
* @param bool $trigger Whether to trigger the error for deprecated functions. Default true.
@ -3943,7 +3944,7 @@ function is_main_network( $network_id = null ) {
*
* @since 4.3.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @return int The ID of the main network.
*/
@ -4963,6 +4964,7 @@ function wp_delete_file( $file ) {
/**
* Outputs a small JS snippet on preview tabs/windows to remove `window.name` on unload.
*
* This prevents reusing the same tab for a preview when the user has navigated away.
*
* @since 4.3.0