Changeset 29154

Timestamp:

07/14/2014 12:16:36 AM (11 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-admin/includes/upgrade.php (modified) (3 diffs)

trunk/src/wp-admin/includes/upgrade.php

@@ -2184 +2184 @@
 
 /**
- * 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.
@@ -2215 +2217 @@
 
 /**
- * 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 ) {
@@ -2262 +2266 @@
  * @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 ) {