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.

Built from https://develop.svn.wordpress.org/trunk@30753


git-svn-id: http://core.svn.wordpress.org/trunk@30743 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
2014-12-06 21:24:45 +00:00
parent 14b0899e57
commit 23707b1ada
10 changed files with 86 additions and 69 deletions

View File

@@ -1214,7 +1214,7 @@ function comments_rss() {
*
* @param string $username The user's username.
* @param string $password The user's password.
* @param string $email The user's email (optional).
* @param string $email The user's email.
* @return int The new user's ID.
*/
function create_user($username, $password, $email) {