Make WordPress Core


Ignore:
Timestamp:
12/06/2014 09:23:52 PM (10 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/wp-db.php

    r30699 r30753  
    736736     *
    737737     * @param resource $dbh     The resource given by mysql_connect
    738      * @param string   $charset The character set (optional)
    739      * @param string   $collate The collation (optional)
     738     * @param string   $charset Optional. The character set. Default null.
     739     * @param string   $collate Optional. The collation. Default null.
    740740     */
    741741    public function set_charset( $dbh, $charset = null, $collate = null ) {
Note: See TracChangeset for help on using the changeset viewer.