WordPress.org

Make WordPress Core

Changeset 36250


Ignore:
Timestamp:
01/10/2016 01:25:44 AM (4 years ago)
Author:
johnbillion
Message:

Docs: Various docblock corrections.

See #32246

Location:
trunk/src
Files:
9 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/custom-header.php

    r35905 r36250  
    262262     *
    263263     * @since 3.0.0
     264     *
     265     * @param string $type The header type. One of 'default' (for the Uploaded Images control)
     266     *                     or 'uploaded' (for the Uploaded Images control).
    264267     */
    265268    public function show_header_selector( $type = 'default' ) {
     
    970973     * or provide an array of uploaded header data (either new, or from media library).
    971974     *
     975     * @since 3.4.0
     976     *
    972977     * @param mixed $choice Which header image to select. Allows for values of 'random-default-image',
    973978     *  for randomly cycling among the default images; 'random-uploaded-image', for randomly cycling
     
    975980     *  the key of an image uploaded for that theme (the basename of the URL).
    976981     *  Or an array of arguments: attachment_id, url, width, height. All are required.
    977      *
    978      * @since 3.4.0
    979      *
    980      * @param array|object|string $choice
    981982     */
    982983    final public function set_header_image( $choice ) {
  • trunk/src/wp-admin/includes/class-wp-filesystem-base.php

    r35662 r36250  
    706706     * @abstract
    707707     *
     708     * @param string $file Path to file.
    708709     * @return bool Whether $file is writable.
    709710     */
  • trunk/src/wp-admin/includes/dashboard.php

    r36172 r36250  
    11451145 *
    11461146 * @since 2.5.0
     1147 *
     1148 * @param string $rss  The RSS feed URL.
     1149 * @param array  $args Array of arguments for this RSS feed.
    11471150 */
    11481151function wp_dashboard_plugins_output( $rss, $args = array() ) {
  • trunk/src/wp-admin/includes/schema.php

    r35738 r36250  
    889889 * @global WP_Rewrite $wp_rewrite
    890890 *
    891  * @param int $network_id ID of network to populate.
     891 * @param int    $network_id        ID of network to populate.
     892 * @param string $domain            The domain name for the network (eg. "example.com").
     893 * @param string $email             Email address for the network administrator.
     894 * @param string $site_name         The name of the network.
     895 * @param string $path              Optional. The path to append to the network's domain name. Default '/'.
     896 * @param bool   $subdomain_install Optional. Whether the network is a subdomain install or a subdirectory install.
     897 *                                  Default false, meaning the network is a subdirectory install.
    892898 * @return bool|WP_Error True on success, or WP_Error on warning (with the install otherwise successful,
    893899 *                       so the error code must be checked) or failure.
  • trunk/src/wp-includes/class-feed.php

    r34348 r36250  
    1010     * @static
    1111     * @access public
     12     *
     13     * @param string $location  URL location (scheme is used to determine handler).
     14     * @param string $filename  Unique identifier for cache object.
     15     * @param string $extension 'spi' or 'spc'.
     16     * @return WP_Feed_Cache_Transient Feed cache handler object that uses transients.
    1217     */
    1318    public function create($location, $filename, $extension) {
     
    2126    public $lifetime = 43200; //Default lifetime in cache of 12 hours
    2227
     28    /**
     29     * Class instantiator.
     30     *
     31     * @param string $location  URL location (scheme is used to determine handler).
     32     * @param string $filename  Unique identifier for cache object.
     33     * @param string $extension 'spi' or 'spc'.
     34     */
    2335    public function __construct($location, $filename, $extension) {
    2436        $this->name = 'feed_' . $filename;
  • trunk/src/wp-includes/class-wp-comment.php

    r34730 r36250  
    351351     *
    352352     * @since 4.4.0
     353     *
     354     * @param bool $set Whether the comment's children have already been populated.
    353355     */
    354356    public function populated_children( $set ) {
  • trunk/src/wp-includes/class-wp-image-editor.php

    r33734 r36250  
    2222    /**
    2323     * Each instance handles a single file.
     24     *
     25     * @param string $file Path to the file to load.
    2426     */
    2527    public function __construct( $file ) {
  • trunk/src/wp-includes/class-wp-term.php

    r35537 r36250  
    238238     * @access public
    239239     *
    240      * @return mixed
     240     * @param string $key Property to get.
     241     * @return mixed Property value.
    241242     */
    242243    public function __get( $key ) {
  • trunk/src/wp-includes/class-wp-theme.php

    r36185 r36250  
    351351     * __get() magic method for properties formerly returned by current_theme_info()
    352352     *
    353      * @return mixed
     353     * @param string $offset Property to get.
     354     * @return mixed Property value.
    354355     */
    355356    public function __get( $offset ) {
Note: See TracChangeset for help on using the changeset viewer.