From 204a4bc6bf5e8cd013687451f83558e93b8bc2b6 Mon Sep 17 00:00:00 2001
From: Drew Jaynes <info@drewapicture.com>
Date: Mon, 14 Jul 2014 00:17:15 +0000
Subject: [PATCH] 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
---
 wp-admin/includes/upgrade.php | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

diff --git a/wp-admin/includes/upgrade.php b/wp-admin/includes/upgrade.php
index bcfd192486..be442b9f62 100644
--- a/wp-admin/includes/upgrade.php
+++ b/wp-admin/includes/upgrade.php
@@ -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
  *
+ * @see wp_remote_post()
+ *
  * @return array Array of translations, each an array of data.
  */
 function wp_get_available_translations_from_api() {
@@ -2214,13 +2216,15 @@ function wp_get_available_translations_from_api() {
 }
 
 /**
- * Downloads a language pack.
+ * Download a language pack.
  *
  * @since 4.0.0
  *
+ * @see wp_get_available_translations_from_api()
+ *
  * @param string $download Language code to download.
- * @return string|false Returns the language code if successfully downloaded
- *                      (or already installed), or false on failure.
+ * @return string|bool Returns the language code if successfully downloaded
+ *                     (or already installed), or false on failure.
  */
 function wp_install_download_language_pack( $download ) {
 	// Check if the translation is already installed.
@@ -2261,9 +2265,11 @@ function wp_install_download_language_pack( $download ) {
  *
  * @since 4.0.0
  *
+ * @see load_textdomain()
+ *
  * @param string $translation Translation to load.
- * @return string|false Returns the language code if successfully loaded,
- *                      or false on failure.
+ * @return string|bool Returns the language code if successfully loaded,
+ *                     or false on failure.
  */
 function wp_install_load_language( $translation ) {
 	if ( ! empty( $translation ) ) {