wp/wp-includes/pomo/translations.php
changeset 5 5e2f62d02dcd
parent 0 d970ebf37754
child 7 cf61fcea0001
--- a/wp/wp-includes/pomo/translations.php	Mon Jun 08 16:11:51 2015 +0000
+++ b/wp/wp-includes/pomo/translations.php	Tue Jun 09 03:35:32 2015 +0200
@@ -17,7 +17,7 @@
 	/**
 	 * Add entry to the PO structure
 	 *
-	 * @param object &$entry
+	 * @param array|Translation_Entry &$entry
 	 * @return bool true on success, false if the entry doesn't have a key
 	 */
 	function add_entry($entry) {
@@ -30,6 +30,10 @@
 		return true;
 	}
 
+	/**
+	 * @param array|Translation_Entry $entry
+	 * @return bool
+	 */
 	function add_entry_or_merge($entry) {
 		if (is_array($entry)) {
 			$entry = new Translation_Entry($entry);
@@ -57,21 +61,35 @@
 		$this->headers[$header] = $value;
 	}
 
+	/**
+	 * @param array $headers
+	 */
 	function set_headers($headers) {
 		foreach($headers as $header => $value) {
 			$this->set_header($header, $value);
 		}
 	}
 
+	/**
+	 * @param string $header
+	 */
 	function get_header($header) {
 		return isset($this->headers[$header])? $this->headers[$header] : false;
 	}
 
+	/**
+	 * @param Translation_Entry $entry
+	 */
 	function translate_entry(&$entry) {
 		$key = $entry->key();
 		return isset($this->entries[$key])? $this->entries[$key] : false;
 	}
 
+	/**
+	 * @param string $singular
+	 * @param string $context
+	 * @return string
+	 */
 	function translate($singular, $context=null) {
 		$entry = new Translation_Entry(array('singular' => $singular, 'context' => $context));
 		$translated = $this->translate_entry($entry);
@@ -97,6 +115,12 @@
 		return 2;
 	}
 
+	/**
+	 * @param string $singular
+	 * @param string $plural
+	 * @param int    $count
+	 * @param string $context
+	 */
 	function translate_plural($singular, $plural, $count, $context = null) {
 		$entry = new Translation_Entry(array('singular' => $singular, 'plural' => $plural, 'context' => $context));
 		$translated = $this->translate_entry($entry);
@@ -139,6 +163,7 @@
 	 * It lives in this class, because there are more than one descendand, which will use it and
 	 * they can't share it effectively.
 	 *
+	 * @param int $count
 	 */
 	function gettext_select_plural_form($count) {
 		if (!isset($this->_gettext_select_plural_form) || is_null($this->_gettext_select_plural_form)) {
@@ -149,6 +174,10 @@
 		return call_user_func($this->_gettext_select_plural_form, $count);
 	}
 
+	/**
+	 * @param string $header
+	 * @return array
+	 */
 	function nplurals_and_expression_from_header($header) {
 		if (preg_match('/^\s*nplurals\s*=\s*(\d+)\s*;\s+plural\s*=\s*(.+)$/', $header, $matches)) {
 			$nplurals = (int)$matches[1];
@@ -162,6 +191,8 @@
 	/**
 	 * Makes a function, which will return the right translation index, according to the
 	 * plural forms header
+	 * @param int    $nplurals
+	 * @param string $expression
 	 */
 	function make_plural_form_function($nplurals, $expression) {
 		$expression = str_replace('n', '$n', $expression);
@@ -172,7 +203,7 @@
 	}
 
 	/**
-	 * Adds parantheses to the inner parts of ternary operators in
+	 * Adds parentheses to the inner parts of ternary operators in
 	 * plural expressions, because PHP evaluates ternary oerators from left to right
 	 *
 	 * @param string $expression the expression without parentheses
@@ -203,6 +234,10 @@
 		return rtrim($res, ';');
 	}
 
+	/**
+	 * @param string $translation
+	 * @return array
+	 */
 	function make_headers($translation) {
 		$headers = array();
 		// sometimes \ns are used instead of real new lines
@@ -216,6 +251,10 @@
 		return $headers;
 	}
 
+	/**
+	 * @param string $header
+	 * @param string $value
+	 */
 	function set_header($header, $value) {
 		parent::set_header($header, $value);
 		if ('Plural-Forms' == $header) {
@@ -253,6 +292,10 @@
 		return false;
 	}
 
+	/**
+	 * @param string $singular
+	 * @param string $context
+	 */
 	function translate($singular, $context=null) {
 		return $singular;
 	}
@@ -265,6 +308,12 @@
 		return 2;
 	}
 
+	/**
+	 * @param string $singular
+	 * @param string $plural
+	 * @param int    $count
+	 * @param string $context
+	 */
 	function translate_plural($singular, $plural, $count, $context = null) {
 			return 1 == $count? $singular : $plural;
 	}