IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: Remove inline @see tags from function, class, and method references in inline docs.

Browse Source 
Known functions, classes, and methods are now auto-linked in Code Reference pages following #meta1483.

Note: Hook references are still linked via inline `@see` tags due to the unlikelihood of reliably matching for known hooks based on a RegEx pattern.

See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@37308 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
2016-05-02 04:00:28 +00:00
parent 9354965638
commit fe3b007fdd
39 changed files with 163 additions and 170 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
wp-admin/includes/class-wp-list-table.php
View File

@@ -125,7 +125,7 @@ class WP_List_Table {
* Default empty
* @type bool $ajax Whether the list table supports AJAX. This includes loading
* and sorting data, for example. If true, the class will call
* the {@see _js_vars()} method in the footer to provide variables
* the _js_vars() method in the footer to provide variables
* to any scripts handling AJAX events. Default false.
* @type string $screen String containing the hook name used to determine the current
* screen. If left null, the current screen will be automatically set.

64
wp-admin/includes/class-wp-upgrader.php
View File

@@ -42,9 +42,9 @@ class WP_Upgrader {
/**
* The result of the installation.
*
* This is set by {@see WP_Upgrader::install_package()}, only when the package is installed
* successfully. It will then be an array, unless a {@see WP_Error} is returned by the
* {@see 'upgrader_post_install'} filter. In that case, the `WP_Error` will be assigned to
* This is set by WP_Upgrader::install_package(), only when the package is installed
* successfully. It will then be an array, unless a WP_Error is returned by the
* {@see 'upgrader_post_install'} filter. In that case, the WP_Error will be assigned to
* it.
*
* @since 2.8.0
@@ -93,7 +93,7 @@ class WP_Upgrader {
* @since 2.8.0
* @access public
*
* @param WP_Upgrader_Skin $skin The upgrader skin to use. Default is a {@see WP_Upgrader_Skin}
* @param WP_Upgrader_Skin $skin The upgrader skin to use. Default is a WP_Upgrader_Skin.
* instance.
*/
public function __construct( $skin = null ) {
@@ -155,11 +155,11 @@ class WP_Upgrader {
* @global WP_Filesystem_Base $wp_filesystem Subclass
*
* @param array $directories Optional. A list of directories. If any of these do
* not exist, a {@see WP_Error} object will be returned.
* not exist, a WP_Error object will be returned.
* Default empty array.
* @param bool $allow_relaxed_file_ownership Whether to allow relaxed file ownership.
* Default false.
* @return bool|WP_Error True if able to connect, false or a {@see WP_Error} otherwise.
* @return bool|WP_Error True if able to connect, false or a WP_Error otherwise.
*/
public function fs_connect( $directories = array(), $allow_relaxed_file_ownership = false ) {
global $wp_filesystem;
@@ -218,7 +218,7 @@ class WP_Upgrader {
*
* @param string $package The URI of the package. If this is the full path to an
* existing local file, it will be returned untouched.
* @return string|WP_Error The full path to the downloaded package file, or a {@see WP_Error} object.
* @return string|WP_Error The full path to the downloaded package file, or a WP_Error object.
*/
public function download_package( $package ) {
@@ -264,7 +264,7 @@ class WP_Upgrader {
* @param string $package Full path to the package file.
* @param bool $delete_package Optional. Whether to delete the package file after attempting
* to unpack it. Default true.
* @return string|WP_Error The path to the unpacked contents, or a {@see WP_Error} on failure.
* @return string|WP_Error The path to the unpacked contents, or a WP_Error on failure.
*/
public function unpack_package( $package, $delete_package = true ) {
global $wp_filesystem;
@@ -391,10 +391,10 @@ class WP_Upgrader {
* @type bool $abort_if_destination_exists Whether to abort the installation if
* the destination folder already exists. Default true.
* @type array $hook_extra Extra arguments to pass to the filter hooks called by
* {@see WP_Upgrader::install_package()}. Default empty array.
* WP_Upgrader::install_package(). Default empty array.
* }
*
* @return array|WP_Error The result (also stored in `WP_Upgrader:$result`), or a {@see WP_Error} on failure.
* @return array|WP_Error The result (also stored in `WP_Upgrader::$result`), or a WP_Error on failure.
*/
public function install_package( $args = array() ) {
global $wp_filesystem, $wp_theme_directories;
@@ -600,10 +600,10 @@ class WP_Upgrader {
* should be false. Default true.
* @type bool $is_multi Whether this run is one of multiple upgrade/install
* actions being performed in bulk. When true, the skin
* {@see WP_Upgrader::header()} and {@see WP_Upgrader::footer()}
* WP_Upgrader::header() and WP_Upgrader::footer()
* aren't called. Default false.
* @type array $hook_extra Extra arguments to pass to the filter hooks called by
* {@see WP_Upgrader::run()}.
* WP_Upgrader::run().
* }
* @return array|false|WP_error The result from self::install_package() on success, otherwise a WP_Error,
* or false if unable to connect to the filesystem.
@@ -949,7 +949,7 @@ class Plugin_Upgrader extends WP_Upgrader {
* @type bool $clear_update_cache Whether to clear the plugin updates cache if successful.
* Default true.
* }
* @return bool|WP_Error True if the upgrade was successful, false or a {@see WP_Error} object otherwise.
* @return bool|WP_Error True if the upgrade was successful, false or a WP_Error object otherwise.
*/
public function upgrade( $plugin, $args = array() ) {
@@ -1143,7 +1143,7 @@ class Plugin_Upgrader extends WP_Upgrader {
* Check a source package to be sure it contains a plugin.
*
* This function is added to the {@see 'upgrader_source_selection'} filter by
* {@see Plugin_Upgrader::install()}.
* Plugin_Upgrader::install().
*
* @since 3.3.0
* @access public
@@ -1151,7 +1151,7 @@ class Plugin_Upgrader extends WP_Upgrader {
* @global WP_Filesystem_Base $wp_filesystem Subclass
*
* @param string $source The path to the downloaded package source.
* @return string|WP_Error The source as passed, or a {@see WP_Error} object
* @return string|WP_Error The source as passed, or a WP_Error object
* if no plugins were found.
*/
public function check_package($source) {
@@ -1211,7 +1211,7 @@ class Plugin_Upgrader extends WP_Upgrader {
/**
* Deactivates a plugin before it is upgraded.
*
* Hooked to the {@see 'upgrader_pre_install'} filter by {@see Plugin_Upgrader::upgrade()}.
* Hooked to the {@see 'upgrader_pre_install'} filter by Plugin_Upgrader::upgrade().
*
* @since 2.8.0
* @since 4.1.0 Added a return value.
@@ -1219,7 +1219,7 @@ class Plugin_Upgrader extends WP_Upgrader {
*
* @param bool|WP_Error $return Upgrade offer return.
* @param array $plugin Plugin package arguments.
* @return bool|WP_Error The passed in $return param or {@see WP_Error}.
* @return bool|WP_Error The passed in $return param or WP_Error.
*/
public function deactivate_plugin_before_upgrade($return, $plugin) {
@@ -1246,7 +1246,7 @@ class Plugin_Upgrader extends WP_Upgrader {
* Delete the old plugin during an upgrade.
*
* Hooked to the {@see 'upgrader_clear_destination'} filter by
* {@see Plugin_Upgrader::upgrade()} and {@see Plugin_Upgrader::bulk_upgrade()}.
* Plugin_Upgrader::upgrade() and Plugin_Upgrader::bulk_upgrade().
*
* @since 2.8.0
* @access public
@@ -1365,7 +1365,7 @@ class Theme_Upgrader extends WP_Upgrader {
/**
* Check if a child theme is being installed and we need to install its parent.
*
* Hooked to the {@see 'upgrader_post_install'} filter by {@see Theme_Upgrader::install()}.
* Hooked to the {@see 'upgrader_post_install'} filter by Theme_Upgrader::install().
*
* @since 3.4.0
* @access public
@@ -1438,7 +1438,7 @@ class Theme_Upgrader extends WP_Upgrader {
* Don't display the activate and preview actions to the user.
*
* Hooked to the {@see 'install_theme_complete_actions'} filter by
* {@see Theme_Upgrader::check_parent_theme_filter()} when installing
* Theme_Upgrader::check_parent_theme_filter() when installing
* a child theme and installing the parent theme fails.
*
* @since 3.4.0
@@ -1467,7 +1467,7 @@ class Theme_Upgrader extends WP_Upgrader {
* Default true.
* }
*
* @return bool|WP_Error True if the install was successful, false or a {@see WP_Error} object otherwise.
* @return bool|WP_Error True if the install was successful, false or a WP_Error object otherwise.
*/
public function install( $package, $args = array() ) {
@@ -1522,7 +1522,7 @@ class Theme_Upgrader extends WP_Upgrader {
* @type bool $clear_update_cache Whether to clear the update cache if successful.
* Default true.
* }
* @return bool|WP_Error True if the upgrade was successful, false or a {@see WP_Error} object otherwise.
* @return bool|WP_Error True if the upgrade was successful, false or a WP_Error object otherwise.
*/
public function upgrade( $theme, $args = array() ) {
@@ -1701,7 +1701,7 @@ class Theme_Upgrader extends WP_Upgrader {
/**
* Check that the package source contains a valid theme.
*
* Hooked to the {@see 'upgrader_source_selection'} filter by {@see Theme_Upgrader::install()}.
* Hooked to the {@see 'upgrader_source_selection'} filter by Theme_Upgrader::install().
* It will return an error if the theme doesn't have style.css or index.php
* files.
*
@@ -1761,8 +1761,8 @@ class Theme_Upgrader extends WP_Upgrader {
/**
* Turn on maintenance mode before attempting to upgrade the current theme.
*
* Hooked to the {@see 'upgrader_pre_install'} filter by {@see Theme_Upgrader::upgrade()} and
* {@see Theme_Upgrader::bulk_upgrade()}.
* Hooked to the {@see 'upgrader_pre_install'} filter by Theme_Upgrader::upgrade() and
* Theme_Upgrader::bulk_upgrade().
*
* @since 2.8.0
* @access public
@@ -1789,8 +1789,8 @@ class Theme_Upgrader extends WP_Upgrader {
/**
* Turn off maintenance mode after upgrading the current theme.
*
* Hooked to the {@see 'upgrader_post_install'} filter by {@see Theme_Upgrader::upgrade()}
* and {@see Theme_Upgrader::bulk_upgrade()}.
* Hooked to the {@see 'upgrader_post_install'} filter by Theme_Upgrader::upgrade()
* and Theme_Upgrader::bulk_upgrade().
*
* @since 2.8.0
* @access public
@@ -1824,8 +1824,8 @@ class Theme_Upgrader extends WP_Upgrader {
/**
* Delete the old theme during an upgrade.
*
* Hooked to the {@see 'upgrader_clear_destination'} filter by {@see Theme_Upgrader::upgrade()}
* and {@see Theme_Upgrader::bulk_upgrade()}.
* Hooked to the {@see 'upgrader_clear_destination'} filter by Theme_Upgrader::upgrade()
* and Theme_Upgrader::bulk_upgrade().
*
* @since 2.8.0
* @access public
@@ -2004,8 +2004,8 @@ class Language_Pack_Upgrader extends WP_Upgrader {
*
* @param string|false $update Optional. Whether an update offer is available. Default false.
* @param array $args Optional. Other optional arguments, see
* {@see Language_Pack_Upgrader::bulk_upgrade()}. Default empty array.
* @return array|bool|WP_Error The result of the upgrade, or a {@see wP_Error} object instead.
* Language_Pack_Upgrader::bulk_upgrade(). Default empty array.
* @return array|bool|WP_Error The result of the upgrade, or a WP_Error object instead.
*/
public function upgrade( $update = false, $args = array() ) {
if ( $update ) {
@@ -2150,7 +2150,7 @@ class Language_Pack_Upgrader extends WP_Upgrader {
* Check the package source to make sure there are .mo and .po files.
*
* Hooked to the {@see 'upgrader_source_selection'} filter by
* {@see Language_Pack_Upgrader::bulk_upgrade()}.
* Language_Pack_Upgrader::bulk_upgrade().
*
* @since 3.7.0
* @access public

4
wp-admin/includes/image-edit.php
View File

@@ -458,9 +458,9 @@ function _crop_image_resource($img, $x, $y, $w, $h) {
*
* @since 2.9.0
*
* @param WP_Image_Editor $image {@see WP_Image_Editor} instance.
* @param WP_Image_Editor $image WP_Image_Editor instance.
* @param array $changes Array of change operations.
* @return WP_Image_Editor {@see WP_Image_Editor} instance with changes applied.
* @return WP_Image_Editor WP_Image_Editor instance with changes applied.
*/
function image_edit_apply_changes( $image, $changes ) {
if ( is_resource( $image ) )

2
wp-admin/includes/media.php
View File

@@ -178,7 +178,7 @@ function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $
* to the image HTML when inserted into the editor.
*
* Passing an empty value also prevents the {@see 'image_add_caption_shortcode'}
* filter from being evaluated at the end of {@see image_add_caption()}.
* filter from being evaluated at the end of image_add_caption().
*
* @since 4.1.0
*

4
wp-admin/includes/ms.php
View File

@@ -621,10 +621,10 @@ function format_code_lang( $code = '' ) {
* @since 3.0.0
*
* @param object $term The term.
* @param string $taxonomy The taxonomy for $term. Should be 'category' or 'post_tag', as these are
* @param string $taxonomy The taxonomy for `$term`. Should be 'category' or 'post_tag', as these are
* the only taxonomies which are processed by this function; anything else
* will be returned untouched.
* @return object|array Returns `$term`, after filtering the 'slug' field with {@see sanitize_title()}
* @return object|array Returns `$term`, after filtering the 'slug' field with sanitize_title()
* if $taxonomy is 'category' or 'post_tag'.
*/
function sync_category_tag_slugs( $term, $taxonomy ) {

18
wp-admin/includes/plugin.php
View File

@@ -570,12 +570,10 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silen
/**
* Fires as a specific plugin is being activated.
*
* This hook is the "activation" hook used internally by
* {@see register_activation_hook()}. The dynamic portion of the
* hook name, `$plugin`, refers to the plugin basename.
* This hook is the "activation" hook used internally by register_activation_hook().
* The dynamic portion of the hook name, `$plugin`, refers to the plugin basename.
*
* If a plugin is silently activated (such as during an update),
* this hook does not fire.
* If a plugin is silently activated (such as during an update), this hook does not fire.
*
* @since 2.0.0
*
@@ -685,12 +683,10 @@ function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {
/**
* Fires as a specific plugin is being deactivated.
*
* This hook is the "deactivation" hook used internally by
* {@see register_deactivation_hook()}. The dynamic portion of the
* hook name, `$plugin`, refers to the plugin basename.
* This hook is the "deactivation" hook used internally by register_deactivation_hook().
* The dynamic portion of the hook name, `$plugin`, refers to the plugin basename.
*
* If a plugin is silently deactivated (such as during an update),
* this hook does not fire.
* If a plugin is silently deactivated (such as during an update), this hook does not fire.
*
* @since 2.0.0
*
@@ -1024,7 +1020,7 @@ function uninstall_plugin($plugin) {
* Fires in uninstall_plugin() once the plugin has been uninstalled.
*
* The action concatenates the 'uninstall_' prefix with the basename of the
* plugin passed to {@see uninstall_plugin()} to create a dynamically-named action.
* plugin passed to uninstall_plugin() to create a dynamically-named action.
*
* @since 2.7.0
*/

4
wp-admin/includes/revision.php
View File

@@ -82,12 +82,12 @@ function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) {
/**
* Filter revisions text diff options.
*
* Filter the options passed to {@see wp_text_diff()} when viewing a post revision.
* Filter the options passed to wp_text_diff() when viewing a post revision.
*
* @since 4.1.0
*
* @param array $args {
* Associative array of options to pass to {@see wp_text_diff()}.
* Associative array of options to pass to wp_text_diff().
*
* @type bool $show_split_view True for split view (two columns), false for
* un-split view (single column). Default true.

11
wp-admin/includes/template.php
View File

@@ -1428,16 +1428,16 @@ function get_settings_errors( $setting = '', $sanitize = false ) {
}
/**
* Display settings errors registered by {@see add_settings_error()}.
* Display settings errors registered by add_settings_error().
*
* Part of the Settings API. Outputs a div for each error retrieved by
* {@see get_settings_errors()}.
* get_settings_errors().
*
* This is called automatically after a settings page based on the
* Settings API is submitted. Errors should be added during the validation
* callback function for a setting defined in {@see register_setting()}
* callback function for a setting defined in register_setting().
*
* The $sanitize option is passed into {@see get_settings_errors()} and will
* The $sanitize option is passed into get_settings_errors() and will
* re-run the setting sanitization
* on its current value.
*
@@ -1451,7 +1451,8 @@ function get_settings_errors( $setting = '', $sanitize = false ) {
*
* @param string $setting Optional slug title of a specific setting who's errors you want.
* @param bool $sanitize Whether to re-sanitize the setting value before returning errors.
* @param bool $hide_on_update If set to true errors will not be shown if the settings page has already been submitted.
* @param bool $hide_on_update If set to true errors will not be shown if the settings page has
* already been submitted.
*/
function settings_errors( $setting = '', $sanitize = false, $hide_on_update = false ) {

2
wp-admin/includes/user.php
View File

@@ -190,7 +190,7 @@ function edit_user( $user_id = 0 ) {
* @since 4.4.0
*
* @param int $user_id ID of the newly created user.
* @param string $notify Type of notification that should happen. See {@see wp_send_new_user_notifications()}
* @param string $notify Type of notification that should happen. See wp_send_new_user_notifications()
* for more information on possible values.
*/
do_action( 'edit_user_created_user', $user_id, $notify );

2
wp-admin/index.php
View File

@@ -111,7 +111,7 @@ include( ABSPATH . 'wp-admin/admin-header.php' );
/**
* Add content to the welcome panel on the admin dashboard.
*
* To remove the default welcome panel, use {@see remove_action()}:
* To remove the default welcome panel, use remove_action():
*
* remove_action( 'welcome_panel', 'wp_welcome_panel' );
*