Changeset 18827 for trunk/wp-includes/l10n.php

Timestamp:

09/29/2011 10:57:43 PM (14 years ago)

Author:

ryan

Message:

phpdoc typo and readability fixes. Props SergeyBiryukov. fixes #18560

File:

• trunk/wp-includes/l10n.php (modified) (12 diffs)

trunk/wp-includes/l10n.php

@@ -17 +17 @@
  * for the locale global set and the locale is returned.
  *
- * The process to get the locale should only be done once but the locale will
+ * The process to get the locale should only be done once, but the locale will
  * always be filtered using the 'locale' hook.
  *
@@ -54 +54 @@
 /**
  * Retrieves the translation of $text. If there is no translation, or
- * the domain isn't loaded the original text is returned.
+ * the domain isn't loaded, the original text is returned.
  *
  * @see __() Don't use translate() directly, use __()
@@ -85 +85 @@
 /**
  * Retrieves the translation of $text. If there is no translation, or
- * the domain isn't loaded the original text is returned.
+ * the domain isn't loaded, the original text is returned.
  *
  * @see translate() An alias of translate()
@@ -100 +100 @@
 /**
  * Retrieves the translation of $text and escapes it for safe use in an attribute.
- * If there is no translation, or the domain isn't loaded the original text is returned.
+ * If there is no translation, or the domain isn't loaded, the original text is returned.
  *
  * @see translate() An alias of translate()
@@ -116 +116 @@
 /**
  * Retrieves the translation of $text and escapes it for safe use in HTML output.
- * If there is no translation, or the domain isn't loaded the original text is returned.
+ * If there is no translation, or the domain isn't loaded, the original text is returned.
  *
  * @see translate() An alias of translate()
@@ -178 +178 @@
  *
  * By including the context in the pot file translators can translate the two
- * string differently.
+ * strings differently.
  *
  * @since 2.8.0
@@ -258 +258 @@
  * Register plural strings in POT file, but don't translate them.
  *
- * Used when you want do keep structures with translatable plural strings and
+ * Used when you want to keep structures with translatable plural strings and
  * use them later.
  *
@@ -292 +292 @@
  *
  * @since 3.1
- * @param array $nooped_plural array with singular, plural and context keys, usually the result of _n_noop() or _nx_noop()
- * @param int $count number of objects
+ * @param array $nooped_plural Array with singular, plural and context keys, usually the result of _n_noop() or _nx_noop()
+ * @param int $count Number of objects
  * @param string $domain Optional. The domain identifier the text should be retrieved in
  */
@@ -317 +317 @@
  * @param string $domain Unique identifier for retrieving translated strings
  * @param string $mofile Path to the .mo file
- * @return bool true on success, false on failure
+ * @return bool True on success, false on failure
  */
 function load_textdomain( $domain, $mofile ) {
@@ -374 +374 @@
  *
  * Loads the .mo file in WP_LANG_DIR constant path from WordPress root. The
- * translated (.mo) file is named based off of the locale.
+ * translated (.mo) file is named based on the locale.
  *
  * @since 1.5.0
@@ -423 +423 @@
  *
  * @param string $domain Unique identifier for retrieving translated strings
- * @param strings $mu_plugin_rel_path Relative to WPMU_PLUGIN_DIR directory in which
- * the MO file resides. Defaults is empty string.
+ * @param string $mu_plugin_rel_path Relative to WPMU_PLUGIN_DIR directory in which
+ * the MO file resides. Defaults to empty string.
  */
 function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
@@ -521 +521 @@
  *
  * @param string $dir A directory in which to search for language files. The default directory is WP_LANG_DIR.
- * @return array Array of language codes or an empty array if no languages are present.  Language codes are formed by stripping the .mo extension from the language file names.
+ * @return array Array of language codes or an empty array if no languages are present. Language codes are formed by stripping the .mo extension from the language file names.
  */
 function get_available_languages( $dir = null ) {