Make WordPress Core


Ignore:
Timestamp:
12/06/2014 09:23:52 PM (9 years ago)
Author:
DrewAPicture
Message:

Convert various uses of (optional) in core parameter descriptions to use the style prescribed in the inline documentation standards for PHP.

The style for marking parameters optional in inline PHP docs is: @param type $var Optional. Description. Accepts. Default., where Accepts can be omitted on a case-by-case basis.

Props coffee2code.
Fixes #30591.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class.wp-scripts.php

    r30403 r30753  
    4848
    4949    /**
    50      * Prints scripts
     50     * Prints scripts.
    5151     *
    5252     * Prints the scripts passed to it or the print queue. Also prints all necessary dependencies.
    5353     *
    54      * @param mixed $handles (optional) Scripts to be printed. (void) prints queue, (string) prints that script, (array of strings) prints those scripts.
    55      * @param int $group (optional) If scripts were queued in groups prints this group number.
    56      * @return array Scripts that have been printed
     54     * @param mixed $handles Optional. Scripts to be printed. (void) prints queue, (string) prints
     55     *                       that script, (array of strings) prints those scripts. Default false.
     56     * @param int   $group   Optional. If scripts were queued in groups prints this group number.
     57     *                       Default false.
     58     * @return array Scripts that have been printed.
    5759     */
    5860    public function print_scripts( $handles = false, $group = false ) {
Note: See TracChangeset for help on using the changeset viewer.