WordPress.org

Make WordPress Core

Changeset 37487


Ignore:
Timestamp:
05/22/2016 05:39:00 PM (3 years ago)
Author:
DrewAPicture
Message:

Docs: Remove/replace invalid inline @link tags in DocBlocks in wp-includes/*.

Fixes #36910.

Location:
trunk/src/wp-includes
Files:
17 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/category-template.php

    r37486 r37487  
    706706 * passed to edit.php for the popular tags edit links.
    707707 *
    708  * The 'exclude' and 'include' arguments are used for the {@link get_tags()}
    709  * function. Only one should be used, because only one will be used and the
    710  * other ignored, if they are both set.
     708 * The 'exclude' and 'include' arguments are used for the get_tags() function. Only one
     709 * should be used, because only one will be used and the other ignored, if they are both set.
    711710 *
    712711 * @since 2.3.0
  • trunk/src/wp-includes/class-wp-ajax-response.php

    r37032 r37487  
    1616
    1717    /**
    18      * Constructor - Passes args to {@link WP_Ajax_Response::add()}.
     18     * Constructor - Passes args to WP_Ajax_Response::add().
    1919     *
    2020     * @since 2.1.0
  • trunk/src/wp-includes/class-wp-embed.php

    r36970 r37487  
    4444     * Since the [embed] shortcode needs to be run earlier than other shortcodes,
    4545     * this function removes all existing shortcodes, registers the [embed] shortcode,
    46      * calls {@link do_shortcode()}, and then re-registers the old shortcodes.
     46     * calls do_shortcode(), and then re-registers the old shortcodes.
    4747     *
    4848     * @global array $shortcode_tags
     
    8989
    9090    /**
    91      * Register an embed handler. Do not use this function directly, use {@link wp_embed_register_handler()} instead.
     91     * Registers an embed handler.
     92     *
     93     * Do not use this function directly, use wp_embed_register_handler() instead.
     94     *
    9295     * This function should probably also only be used for sites that do not support oEmbed.
    9396     *
     
    105108
    106109    /**
    107      * Unregister a previously registered embed handler. Do not use this function directly, use {@link wp_embed_unregister_handler()} instead.
     110     * Unregisters a previously-registered embed handler.
     111     *
     112     * Do not use this function directly, use wp_embed_unregister_handler() instead.
    108113     *
    109114     * @param string $id The handler ID that should be removed.
     
    115120
    116121    /**
    117      * The {@link do_shortcode()} callback function.
    118      *
    119      * Attempts to convert a URL into embed HTML. Starts by checking the URL against the regex of the registered embed handlers.
    120      * If none of the regex matches and it's enabled, then the URL will be given to the {@link WP_oEmbed} class.
     122     * The do_shortcode() callback function.
     123     *
     124     * Attempts to convert a URL into embed HTML. Starts by checking the URL against the regex of
     125     * the registered embed handlers. If none of the regex matches and it's enabled, then the URL
     126     * will be given to the WP_oEmbed class.
    121127     *
    122128     * @param array $attr {
     
    313319
    314320    /**
    315      * Passes any unlinked URLs that are on their own line to {@link WP_Embed::shortcode()} for potential embedding.
    316      *
    317      * @uses WP_Embed::autoembed_callback()
     321     * Passes any unlinked URLs that are on their own line to WP_Embed::shortcode() for potential embedding.
     322     *
     323     * @see WP_Embed::autoembed_callback()
    318324     *
    319325     * @param string $content The content to be searched.
     
    332338
    333339    /**
    334      * Callback function for {@link WP_Embed::autoembed()}.
     340     * Callback function for WP_Embed::autoembed().
    335341     *
    336342     * @param array $match A regex match array.
  • trunk/src/wp-includes/class-wp-error.php

    r32568 r37487  
    1212 *
    1313 * Container for checking for WordPress errors and error messages. Return
    14  * WP_Error and use {@link is_wp_error()} to check if this class is returned.
    15  * Many core WordPress functions pass this class in the event of an error and
     14 * WP_Error and use is_wp_error() to check if this class is returned. Many
     15 * core WordPress functions pass this class in the event of an error and
    1616 * if not handled properly will result in code errors.
    1717 *
  • trunk/src/wp-includes/class-wp-role.php

    r35935 r37487  
    6464
    6565    /**
    66      * Remove capability from role.
     66     * Removes a capability from a role.
    6767     *
    68      * This is a container for {@link WP_Roles::remove_cap()} to remove the
    69      * capability from the role. That is to say, that {@link
    70      * WP_Roles::remove_cap()} implements the functionality, but it also makes
    71      * sense to use this class, because you don't need to enter the role name.
     68     * This is a container for WP_Roles::remove_cap() to remove the
     69     * capability from the role. That is to say, that WP_Roles::remove_cap()
     70     * implements the functionality, but it also makes sense to use this class,
     71     * because you don't need to enter the role name.
    7272     *
    7373     * @since 2.0.0
  • trunk/src/wp-includes/class-wp-xmlrpc-server.php

    r37431 r37487  
    31133113     *     @type int    $category_id
    31143114     * }
    3115      * @return bool|IXR_Error See {@link wp_delete_term()} for return info.
     3115     * @return bool|IXR_Error See wp_delete_term() for return info.
    31163116     */
    31173117    public function wp_deleteCategory( $args ) {
     
    32453245     * - 'post_id' - Default is ''. The post where the comment is posted. Empty string shows all comments.
    32463246     * - 'number' - Default is 10. Total number of media items to retrieve.
    3247      * - 'offset' - Default is 0. See {@link WP_Query::query()} for more.
     3247     * - 'offset' - Default is 0. See WP_Query::query() for more.
    32483248     *
    32493249     * @since 2.7.0
     
    32573257     *     @type array  $struct
    32583258     * }
    3259      * @return array|IXR_Error Contains a collection of comments. See {@link wp_xmlrpc_server::wp_getComment()} for a description of each item contents
     3259     * @return array|IXR_Error Contains a collection of comments. See wp_xmlrpc_server::wp_getComment() for a description of each item contents
    32603260     */
    32613261    public function wp_getComments( $args ) {
     
    33293329     *
    33303330     * By default, the comment will be moved to the trash instead of deleted.
    3331      * See {@link wp_delete_comment()} for more information on
    3332      * this behavior.
     3331     * See wp_delete_comment() for more information on this behavior.
    33333332     *
    33343333     * @since 2.7.0
     
    33423341     *     @type int    $comment_ID
    33433342     * }
    3344      * @return bool|IXR_Error {@link wp_delete_comment()}
     3343     * @return bool|IXR_Error See wp_delete_comment().
    33453344     */
    33463345    public function wp_deleteComment( $args ) {
     
    34993498     *     @type array      $content_struct
    35003499     * }
    3501      * @return int|IXR_Error {@link wp_new_comment()}
     3500     * @return int|IXR_Error See wp_new_comment().
    35023501     */
    35033502    public function wp_newComment($args) {
  • trunk/src/wp-includes/class-wp.php

    r37366 r37487  
    719719     * @access public
    720720     *
    721      * @param string|array $query_args Passed to {@link parse_request()}
     721     * @param string|array $query_args Passed to parse_request().
    722722     */
    723723    public function main($query_args = '') {
  • trunk/src/wp-includes/comment.php

    r37423 r37487  
    324324 * The amount of comments in a post or total comments.
    325325 *
    326  * A lot like {@link wp_count_comments()}, in that they both return comment
    327  * stats (albeit with different types). The {@link wp_count_comments()} actual
    328  * caches, but this function does not.
     326 * A lot like wp_count_comments(), in that they both return comment stats (albeit with different types).
     327 * The wp_count_comments() actually caches, but this function does not.
    329328 *
    330329 * @since 2.0.0
  • trunk/src/wp-includes/cron.php

    r36299 r37487  
    458458 * @access private
    459459 *
    460  * @param array $cron Cron info array from {@link _get_cron_array()}.
     460 * @param array $cron Cron info array from _get_cron_array().
    461461 */
    462462function _set_cron_array($cron) {
     
    473473 * @access private
    474474 *
    475  * @param array $cron Cron info array from {@link _get_cron_array()}.
     475 * @param array $cron Cron info array from _get_cron_array().
    476476 * @return array An upgraded Cron info array.
    477477 */
  • trunk/src/wp-includes/deprecated.php

    r37431 r37487  
    21272127
    21282128/**
    2129  * Alias of {@link wp_unregister_sidebar_widget()}.
     2129 * Serves as an alias of wp_unregister_sidebar_widget().
    21302130 *
    21312131 * @since 2.2.0
  • trunk/src/wp-includes/formatting.php

    r37473 r37487  
    21052105 * Callback to convert URI match to HTML A element.
    21062106 *
    2107  * This function was backported from 2.5.0 to 2.3.2. Regex callback for {@link
    2108  * make_clickable()}.
     2107 * This function was backported from 2.5.0 to 2.3.2. Regex callback for make_clickable().
    21092108 *
    21102109 * @since 2.3.2
     
    21422141 * Callback to convert URL match to HTML A element.
    21432142 *
    2144  * This function was backported from 2.5.0 to 2.3.2. Regex callback for {@link
    2145  * make_clickable()}.
     2143 * This function was backported from 2.5.0 to 2.3.2. Regex callback for make_clickable().
    21462144 *
    21472145 * @since 2.3.2
     
    21722170 * Callback to convert email address match to HTML A element.
    21732171 *
    2174  * This function was backported from 2.5.0 to 2.3.2. Regex callback for {@link
    2175  * make_clickable()}.
     2172 * This function was backported from 2.5.0 to 2.3.2. Regex callback for make_clickable().
    21762173 *
    21772174 * @since 2.3.2
     
    23682365 * Convert one smiley code to the icon graphic file equivalent.
    23692366 *
    2370  * Callback handler for {@link convert_smilies()}.
     2367 * Callback handler for convert_smilies().
     2368 *
    23712369 * Looks up one smiley code in the $wpsmiliestrans global array and returns an
    23722370 * `<img>` string for that smiley.
  • trunk/src/wp-includes/general-template.php

    r37431 r37487  
    28512851
    28522852/**
    2853  * Retrieve the contents of the search WordPress query variable.
    2854  *
    2855  * The search query string is passed through {@link esc_attr()}
    2856  * to ensure that it is safe for placing in an html attribute.
     2853 * Retrieves the contents of the search WordPress query variable.
     2854 *
     2855 * The search query string is passed through esc_attr() to ensure that it is safe
     2856 * for placing in an html attribute.
    28572857 *
    28582858 * @since 2.3.0
     
    28782878
    28792879/**
    2880  * Display the contents of the search query variable.
    2881  *
    2882  * The search query string is passed through {@link esc_attr()}
    2883  * to ensure that it is safe for placing in an html attribute.
     2880 * Displays the contents of the search query variable.
     2881 *
     2882 * The search query string is passed through esc_attr() to ensure that it is safe
     2883 * for placing in an html attribute.
    28842884 *
    28852885 * @since 2.1.0
     
    29872987 *
    29882988 * It is possible to add query vars to the link by using the 'add_args' argument
    2989  * and see {@link add_query_arg()} for more information.
     2989 * and see add_query_arg() for more information.
    29902990 *
    29912991 * The 'before_page_number' and 'after_page_number' arguments allow users to
  • trunk/src/wp-includes/post-template.php

    r37249 r37487  
    5757 * Sanitize the current title when retrieving or displaying.
    5858 *
    59  * Works like {@link the_title()}, except the parameters can be in a string or
     59 * Works like the_title(), except the parameters can be in a string or
    6060 * an array. See the function for what can be override in the $args parameter.
    6161 *
    62  * The title before it is displayed will have the tags stripped and {@link
    63  * esc_attr()} before it is passed to the user or displayed. The default
    64  * as with {@link the_title()}, is to display the title.
     62 * The title before it is displayed will have the tags stripped and esc_attr()
     63 * before it is passed to the user or displayed. The default as with the_title(),
     64 * is to display the title.
    6565 *
    6666 * @since 2.3.0
     
    12101210
    12111211/**
    1212  * Display or retrieve list of pages with optional home link.
    1213  *
    1214  * The arguments are listed below and part of the arguments are for {@link
    1215  * wp_list_pages()} function. Check that function for more info on those
    1216  * arguments.
     1212 * Displays or retrieves a list of pages with an optional home link.
     1213 *
     1214 * The arguments are listed below and part of the arguments are for wp_list_pages()} function.
     1215 * Check that function for more info on those arguments.
    12171216 *
    12181217 * @since 2.7.0
  • trunk/src/wp-includes/post.php

    r37481 r37487  
    287287 *
    288288 * The arguments listed as defaults are for this function and also of the
    289  * {@link get_posts()} function. The arguments are combined with the
    290  * get_children defaults and are then passed to the {@link get_posts()}
    291  * function, which accepts additional arguments. You can replace the defaults in
    292  * this function, listed below and the additional arguments listed in the
    293  * {@link get_posts()} function.
     289 * get_posts() function. The arguments are combined with the get_children defaults
     290 * and are then passed to the get_posts() function, which accepts additional arguments.
     291 * You can replace the defaults in this function, listed below and the additional
     292 * arguments listed in the get_posts() function.
    294293 *
    295294 * The 'post_parent' is the most important argument and important attention
     
    413412 * Retrieves post data given a post ID or post object.
    414413 *
    415  * See {@link sanitize_post()} for optional $filter values. Also, the parameter
    416  * $post, must be given as a variable, since it is passed by reference.
     414 * See sanitize_post() for optional $filter values. Also, the parameter
     415 * `$post`, must be given as a variable, since it is passed by reference.
    417416 *
    418417 * @since 1.5.1
     
    28712870 * There is only one default for this function, called 'fields' and by default
    28722871 * is set to 'all'. There are other defaults that can be overridden in
    2873  * {@link wp_get_object_terms()}.
     2872 * wp_get_object_terms().
    28742873 *
    28752874 * @since 2.3.0
     
    28892888 * There is only one default for this function, called 'fields' and by default
    28902889 * is set to 'all'. There are other defaults that can be overridden in
    2891  * {@link wp_get_object_terms()}.
     2890 * wp_get_object_terms().
    28922891 *
    28932892 * @since 2.8.0
     
    28962895 *                         global $post. Default 0.
    28972896 * @param string $taxonomy Optional. The taxonomy for which to retrieve terms. Default 'post_tag'.
    2898  * @param array  $args     Optional. {@link wp_get_object_terms()} arguments. Default empty array.
     2897 * @param array  $args     Optional. wp_get_object_terms() arguments. Default empty array.
    28992898 * @return array|WP_Error  List of post terms or empty array if no terms were found. WP_Error object
    29002899 *                         if `$taxonomy` doesn't exist.
  • trunk/src/wp-includes/query.php

    r37431 r37487  
    9696
    9797/**
    98  * Destroy the previous query and set up a new query.
    99  *
    100  * This should be used after {@link query_posts()} and before another {@link
    101  * query_posts()}. This will remove obscure bugs that occur when the previous
    102  * wp_query object is not destroyed properly before another is set up.
     98 * Destroys the previous query and sets up a new query.
     99 *
     100 * This should be used after query_posts() and before another query_posts().
     101 * This will remove obscure bugs that occur when the previous WP_Query object
     102 * is not destroyed properly before another is set up.
    103103 *
    104104 * @since 2.3.0
  • trunk/src/wp-includes/template.php

    r36965 r37487  
    1212 * Used to quickly retrieve the path of a template without including the file
    1313 * extension. It will also check the parent theme, if the file exists, with
    14  * the use of {@link locate_template()}. Allows for more generic template location
     14 * the use of locate_template(). Allows for more generic template location
    1515 * without the use of the other get_*_template() functions.
    1616 *
  • trunk/src/wp-includes/theme.php

    r37431 r37487  
    210210
    211211/**
    212  * Retrieve URI of current theme stylesheet.
    213  *
    214  * The stylesheet file name is 'style.css' which is appended to {@link
    215  * get_stylesheet_directory_uri() stylesheet directory URI} path.
     212 * Retrieves the URI of current theme stylesheet.
     213 *
     214 * The stylesheet file name is 'style.css' which is appended to the stylesheet directory URI path.
     215 * See get_stylesheet_directory_uri().
    216216 *
    217217 * @since 1.5.0
Note: See TracChangeset for help on using the changeset viewer.