Automattic / jetpack

tools/wordpress-i18n/makepot.php

Doc Comments +12 added lines

@@ -152,6 +152,9 @@ 
 			unlink( $temp_file );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	function tempnam( $file ) {
 		$tempnam = tempnam( sys_get_temp_dir(), $file );
 		$this->temp_files[] = $tempnam;
@@ -231,6 +234,9 @@ 
 		return $res;
 	}
 
+	/**
+	 * @param string $output
+	 */
 	function wp_core($dir, $output) {
 		if ( file_exists( "$dir/wp-admin/user/about.php" ) ) return false;
 
@@ -241,6 +247,9 @@ 
 		) );
 	}
 
+	/**
+	 * @param string $output
+	 */
 	function wp_frontend($dir, $output) {
 		if ( ! file_exists( "$dir/wp-admin/user/about.php" ) ) return false;
 
@@ -251,6 +260,9 @@ 
 		) );
 	}
 
+	/**
+	 * @param string $output
+	 */
 	function wp_admin($dir, $output) {
 		if ( ! file_exists( "$dir/wp-admin/user/about.php" ) ) return false;
 

tools/wordpress-i18n/not-gettexted.php

Doc Comments +12 added lines

@@ -51,6 +51,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $dir
+	 */
 	function list_php_files($dir) {
 		$files = array();
 		$items = scandir( $dir );
@@ -67,16 +70,25 @@ 
 	}
 
 
+	/**
+	 * @param string $global_array_name
+	 */
 	function make_string_aggregator($global_array_name, $filename) {
 		$a = $global_array_name;
 		return create_function('$string, $comment_id, $line_number', 'global $'.$a.'; $'.$a.'[] = array($string, $comment_id, '.var_export($filename, true).', $line_number);');
 	}
 
+	/**
+	 * @param string $global_mo_name
+	 */
 	function make_mo_replacer($global_mo_name) {
 		$m = $global_mo_name;
 		return create_function('$token, $string', 'global $'.$m.'; return var_export($'.$m.'->translate($string), true);');
 	}
 
+	/**
+	 * @param string $register_action
+	 */
 	function walk_tokens(&$tokens, $string_action, $other_action, $register_action=null) {
 
 		$current_comment_id = '';

tools/wordpress-i18n/pomo/mo.php

Doc Comments +6 added lines

@@ -99,6 +99,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @return string
+	 */
 	function export_original($entry) {
 		//TODO: warnings for control characters
 		$exported = $entry->singular;
@@ -137,6 +140,9 @@ 
 		}
 	}
 
+	/**
+	 * @param POMO_FileReader $reader
+	 */
 	function import_from_reader($reader) {
 		$endian_string = MO::get_byteorder($reader->readint32());
 		if (false === $endian_string) {

tools/wordpress-i18n/pomo/po.php

Doc Comments +6 added lines, -1 removed lines

@@ -85,6 +85,7 @@ 
 	 * Text to include as a comment before the start of the PO contents
 	 *
 	 * Doesn't need to include # in the beginning of lines, these are added automatically
+	 * @param string $text
 	 */
 	function set_comment_before_headers( $text ) {
 		$this->comments_before_headers = $text;
@@ -190,7 +191,8 @@ 
 	 *
 	 * @static
 	 * @param object &$entry the entry to convert to po string
-	 * @return string|bool PO-style formatted string for the entry or
+	 * @param Translation_Entry $entry
+	 * @return false|string PO-style formatted string for the entry or
 	 * 	false if the entry is empty
 	 */
 	public static function export_entry(&$entry) {
@@ -362,6 +364,9 @@ 
 		return $line;
 	}
 
+	/**
+	 * @param string $po_comment_line
+	 */
 	function add_comment_to_entry(&$entry, $po_comment_line) {
 		$first_two = substr($po_comment_line, 0, 2);
 		$comment = trim(substr($po_comment_line, 2));

tools/wordpress-i18n/pomo/sample/app.php

Doc Comments +10 added lines

@@ -9,6 +9,9 @@ 
 	return $translations->translate($text);
 }
 
+/**
+ * @param string $text
+ */
 function _e($text, $domain = 'default') {
 	$translations = &get_translations($domain);
 	echo $translations->translate($text);
@@ -35,11 +38,18 @@ 
 $translations = array();
 $empty_translations = & new Translations();
 
+/**
+ * @param string $domain
+ * @param string $mofile
+ */
 function load_textdomain($domain, $mofile) {
 	global $translations;
 	$translations[$domain] = &load_translations($mofile);
 }
 
+/**
+ * @param string $domain
+ */
 function &get_translations($domain) {
 	global $translations, $empty_translations;
 	return isset($translations[$domain])? $translations[$domain] : $empty_translations;

tools/wordpress-i18n/pomo/streams.php

Doc Comments +7 added lines

@@ -104,11 +104,18 @@
 
 if ( !class_exists( 'POMO_FileReader' ) ):
 class POMO_FileReader extends POMO_Reader {
+
+	/**
+	 * @param string $filename
+	 */
 	function POMO_FileReader($filename) {
 		parent::POMO_Reader();
 		$this->_f = fopen($filename, 'rb');
 	}
 
+	/**
+	 * @param integer $bytes
+	 */
 	function read($bytes) {
 		return fread($this->_f, $bytes);
 	}

tools/wordpress-i18n/pomo/translations.php

Doc Comments +12 added lines

@@ -63,10 +63,16 @@ 
 		}
 	}
 
+	/**
+	 * @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;
@@ -162,6 +168,8 @@ 
 	/**
 	 * Makes a function, which will return the right translation index, according to the
 	 * plural forms header
+	 * @param integer $nplurals
+	 * @param string $expression
 	 */
 	function make_plural_form_function($nplurals, $expression) {
 		$expression = str_replace('n', '$n', $expression);
@@ -216,6 +224,10 @@ 
 		return $headers;
 	}
 
+	/**
+	 * @param string $header
+	 * @param string $value
+	 */
 	function set_header($header, $value) {
 		parent::set_header($header, $value);
 		if ('Plural-Forms' == $header) {

tools/wordpress-i18n/pot-ext-meta.php

Doc Comments +3 added lines

@@ -47,6 +47,9 @@
 		return $pot;
 	}
 
+	/**
+	 * @param string[] $headers
+	 */
 	function append( $ext_filename, $pot_filename, $headers = null ) {
 		if ( $headers )
 			$this->headers = (array) $headers;