Changeset 36024 for trunk/src/wp-includes/deprecated.php

Timestamp:

12/19/2015 08:47:12 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Add missing parameter and return notations in the DocBlock for the deprecated _nc() function.

See #32246.

File:

• trunk/src/wp-includes/deprecated.php (modified) (2 diffs)

trunk/src/wp-includes/deprecated.php

@@ -1758 +1758 @@
 
 /**
- * A version of _n(), which supports contexts.
+ * Legacy version of _n(), which supports contexts.
+ *
  * Strips everything from the translation after the last bar.
  *
@@ -1764 +1765 @@
  * @deprecated 3.0.0 Use _nx()
  * @see _nx()
+ *
+ * @param string $single The text to be used if the number is singular.
+ * @param string $plural The text to be used if the number is plural.
+ * @param int    $number The number to compare against to use either the singular or plural form.
+ * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ *                       Default 'default'.
+ * @return string The translated singular or plural form.
  */
 function _nc( $single, $plural, $number, $domain = 'default' ) {