Inline documentation cleanup for 4.0 audit.

* phpDoc tweaks for `wp_get_available_translations_from_api()`, `wp_install_download_language_pack()`, and `wp_install_load_language()`, added in [29018]
 
See #28885.

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


git-svn-id: http://core.svn.wordpress.org/trunk@28938 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-07-14 00:17:15 +00:00
parent 52a8488a96
commit 204a4bc6bf

View File

@ -2183,10 +2183,12 @@ function wp_install_language_form( $languages ) {
} }
/** /**
* Gets available translations from the WordPress.org API. * Get available translations from the WordPress.org API.
* *
* @since 4.0.0 * @since 4.0.0
* *
* @see wp_remote_post()
*
* @return array Array of translations, each an array of data. * @return array Array of translations, each an array of data.
*/ */
function wp_get_available_translations_from_api() { function wp_get_available_translations_from_api() {
@ -2214,12 +2216,14 @@ function wp_get_available_translations_from_api() {
} }
/** /**
* Downloads a language pack. * Download a language pack.
* *
* @since 4.0.0 * @since 4.0.0
* *
* @see wp_get_available_translations_from_api()
*
* @param string $download Language code to download. * @param string $download Language code to download.
* @return string|false Returns the language code if successfully downloaded * @return string|bool Returns the language code if successfully downloaded
* (or already installed), or false on failure. * (or already installed), or false on failure.
*/ */
function wp_install_download_language_pack( $download ) { function wp_install_download_language_pack( $download ) {
@ -2261,8 +2265,10 @@ function wp_install_download_language_pack( $download ) {
* *
* @since 4.0.0 * @since 4.0.0
* *
* @see load_textdomain()
*
* @param string $translation Translation to load. * @param string $translation Translation to load.
* @return string|false Returns the language code if successfully loaded, * @return string|bool Returns the language code if successfully loaded,
* or false on failure. * or false on failure.
*/ */
function wp_install_load_language( $translation ) { function wp_install_load_language( $translation ) {