Docs: Split the DocBlock summary for __() into a summary and description.

Also, notate the default value for the optional `$domain` parameter.

See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@34482 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-09-24 05:42:35 +00:00
parent 4d94ef47de
commit 1810710798

View File

@ -152,13 +152,15 @@ function translate_with_gettext_context( $text, $context, $domain = 'default' )
}
/**
* Retrieve the translation of $text. If there is no translation,
* or the text domain isn't loaded, the original text is returned.
* Retrieve the translation of $text.
*
* If there is no translation, or the text domain isn't loaded, the original text is returned.
*
* @since 2.1.0
*
* @param string $text Text to translate.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
* Default 'default'.
* @return string Translated text.
*/
function __( $text, $domain = 'default' ) {