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/user.php

    r30666 r30753  
    20162016 *
    20172017 * Creates a new user with just the username, password, and email. For more
    2018  * complex user creation use wp_insert_user() to specify more information.
     2018 * complex user creation use {@see wp_insert_user()} to specify more information.
    20192019 *
    20202020 * @since 2.0.0
     
    20232023 * @param string $username The user's username.
    20242024 * @param string $password The user's password.
    2025  * @param string $email The user's email (optional).
     2025 * @param string $email    Optional. The user's email. Default empty.
    20262026 * @return int The new user's ID.
    20272027 */
Note: See TracChangeset for help on using the changeset viewer.