Automattic / jetpack

sync/class.jetpack-sync-sender.php

Doc Comments +10 added lines

@@ -52,6 +52,9 @@ 
 		return (double) get_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name, 0 );
 	}
 
+	/**
+	 * @param integer $time
+	 */
 	public function set_next_sync_time( $time, $queue_name ) {
 		return update_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name, $time, true );
 	}
@@ -64,6 +67,9 @@ 
 		return $this->do_sync_and_set_delays( $this->sync_queue );
 	}
 
+	/**
+	 * @param Jetpack_Sync_Queue $queue
+	 */
 	public function do_sync_and_set_delays( $queue ) {
 		// don't sync if importing
 		if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) {
@@ -293,6 +299,10 @@ 
 	}
 
 	// in seconds
+
+	/**
+	 * @param double $seconds
+	 */
 	function set_max_dequeue_time( $seconds ) {
 		$this->max_dequeue_time = $seconds;
 	}

sync/class.jetpack-sync-wp-replicastore.php

Doc Comments +10 added lines

@@ -420,6 +420,10 @@ 
 	}
 
 	// functions
+
+	/**
+	 * @param string $name
+	 */
 	public function get_callable( $name ) {
 		$value = get_option( 'jetpack_' . $name );
 
@@ -688,6 +692,9 @@ 
 		return $histogram;
 	}
 
+	/**
+	 * @param string|null $id_column
+	 */
 	private function table_checksum( $table, $columns, $id_column, $where_sql = '1=1', $min_id = null, $max_id = null, $strip_non_ascii = true ) {
 		global $wpdb;
 
@@ -725,6 +732,9 @@ 
 
 	}
 
+	/**
+	 * @param string $where_sql
+	 */
 	private function meta_count( $table, $where_sql, $min_id, $max_id ) {
 		global $wpdb;
 

modules/custom-css/custom-css/preprocessors/scss.inc.php

Doc Comments +72 added lines

@@ -273,6 +273,9 @@ 
 		}
 	}
 
+	/**
+	 * @param stdClass $block
+	 */
 	protected function flattenSelectors($block, $parentKey = null) {
 		if ($block->selectors) {
 			$selectors = array();
@@ -362,6 +365,10 @@ 
 	}
 
 	// TODO refactor compileNestedBlock and compileMedia into same thing
+
+	/**
+	 * @param string[] $selectors
+	 */
 	protected function compileNestedBlock($block, $selectors) {
 		$this->pushEnv($block);
 
@@ -1140,6 +1147,9 @@ 
 		return $this->toBool($left[1] < $right[1]);
 	}
 
+	/**
+	 * @param boolean $thing
+	 */
 	public function toBool($thing) {
 		return $thing ? self::$true : self::$false;
 	}
@@ -1268,6 +1278,10 @@ 
 	}
 
 	// find the final set of selectors
+
+	/**
+	 * @param stdClass $env
+	 */
 	protected function multiplySelectors($env) {
 		$envs = array();
 		while (null !== $env) {
@@ -1474,6 +1488,9 @@ 
 		$env->store[$name] = $value;
 	}
 
+	/**
+	 * @param boolean $defaultValue
+	 */
 	public function get($name, $defaultValue = null, $env = null) {
 		$name = $this->normalizeName($name);
 
@@ -1503,6 +1520,9 @@ 
 		$this->importPaths[] = $path;
 	}
 
+	/**
+	 * @param string $path
+	 */
 	public function setImportPaths($path) {
 		$this->importPaths = (array)$path;
 	}
@@ -1511,6 +1531,9 @@ 
 		$this->numberPrecision = $numberPrecision;
 	}
 
+	/**
+	 * @param string $formatterName
+	 */
 	public function setFormatter($formatterName) {
 		$this->formatter = $formatterName;
 	}
@@ -1544,6 +1567,10 @@ 
 	}
 
 	// results the file path for an import url if it exists
+
+	/**
+	 * @param string $url
+	 */
 	public function findImport($url) {
 		$urls = array();
 
@@ -1579,6 +1606,9 @@ 
 		return null;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	protected function fileExists($name) {
 		return is_file($name);
 	}
@@ -1766,6 +1796,11 @@ 
 		return array('hsl', fmod($h, 360), $s * 100, $l * 100);
 	}
 
+	/**
+	 * @param double $m1
+	 * @param double $m2
+	 * @param double $h
+	 */
 	public function hueToRGB($m1, $m2, $h) {
 		if ($h < 0)
 			$h += 1;
@@ -1850,6 +1885,10 @@ 
 	}
 
 	// helper function for adjust_color, change_color, and scale_color
+
+	/**
+	 * @param string $fn
+	 */
 	protected function alter_color($args, $fn) {
 		$color = $this->assertColor($args[0]);
 
@@ -2047,6 +2086,9 @@ 
 		return array("number", $hsl[3], "%");
 	}
 
+	/**
+	 * @param integer $idx
+	 */
 	protected function adjustHsl($color, $idx, $amount) {
 		$hsl = $this->toHSL($color[1], $color[2], $color[3]);
 		$hsl[$idx] += $amount;
@@ -2965,6 +3007,10 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $what
+	 * @param boolean $eatWhitespace
+	 */
 	protected function literal($what, $eatWhitespace = null) {
 		if (is_null($eatWhitespace)) $eatWhitespace = $this->eatWhiteDefault;
 
@@ -2997,6 +3043,9 @@ 
 		return $b;
 	}
 
+	/**
+	 * @param string $type
+	 */
 	protected function pushSpecialBlock($type) {
 		$block = $this->pushBlock(null);
 		$block->type = $type;
@@ -3123,6 +3172,9 @@ 
 		return $this->genericList($out, "expression");
 	}
 
+	/**
+	 * @param string $parseItem
+	 */
 	protected function genericList(&$out, $parseItem, $delim="", $flatten=true) {
 		$s = $this->seek();
 		$items = array();
@@ -3171,6 +3223,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param integer $minP
+	 */
 	protected function expHelper($lhs, $minP) {
 		$opstr = self::$operatorStr;
 
@@ -3518,6 +3573,11 @@ 
 	}
 
 	// an unbounded string stopped by $end
+
+	/**
+	 * @param string $end
+	 * @param string $nestingOpen
+	 */
 	protected function openString($end, &$out, $nestingOpen=null) {
 		$oldWhite = $this->eatWhiteDefault;
 		$this->eatWhiteDefault = false;
@@ -3850,6 +3910,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param boolean $eatWhitespace
+	 */
 	protected function keyword(&$word, $eatWhitespace = null) {
 		if ($this->match('([\w_\-\*!"\'\\\\][\w\-_"\'\\\\]*)',
 			$m, $eatWhitespace))
@@ -3959,6 +4022,10 @@ 
 	}
 
 	// try to match something on head of buffer
+
+	/**
+	 * @param string $regex
+	 */
 	protected function match($regex, &$out, $eatWhitespace = null) {
 		if (is_null($eatWhitespace)) $eatWhitespace = $this->eatWhiteDefault;
 
@@ -3987,6 +4054,9 @@ 
 		return $gotWhite;
 	}
 
+	/**
+	 * @param string $regex
+	 */
 	protected function peek($regex, &$out, $from=null) {
 		if (is_null($from)) $from = $this->count;
 
@@ -4253,6 +4323,7 @@ 
 	/**
 	 * Get path to cached .css file
 	 *
+	 * @param string $fname
 	 * @return string
 	 */
 	protected function cacheName($fname) {
@@ -4262,6 +4333,7 @@ 
 	/**
 	 * Get path to cached imports
 	 *
+	 * @param string $out
 	 * @return string
 	 */
 	protected function importsCacheName($out) {

modules/theme-tools/content-options/blog-display.php

Doc Comments +1 added lines

@@ -138,6 +138,7 @@
 /**
  * Returns a class value, `output-the-content` by default.
  * Used for themes with a 'Mixed' Blog Display so we can tell which output is by default.
+ * @param string $new_class
  */
 function jetpack_the_content_customizer_class( $new_class = null ) {
 	static $class;

3rd-party/domain-mapping.php

Doc Comments +10 added lines

@@ -93,14 +93,24 @@
 	 * So that we can test.
 	 */
 
+	/**
+	 * @param string $class
+	 * @param string $method
+	 */
 	public function method_exists( $class, $method ) {
 		return method_exists( $class, $method );
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function class_exists( $class ) {
 		return class_exists( $class );
 	}
 
+	/**
+	 * @param string $function
+	 */
 	public function function_exists( $function ) {
 		return function_exists( $function );
 	}

sync/class.jetpack-sync-actions.php

Doc Comments +6 added lines

@@ -298,6 +298,9 @@ 
 		return $sync_modules;
 	}
 
+	/**
+	 * @return string
+	 */
 	static function sanitize_filtered_sync_cron_schedule( $schedule ) {
 		$schedule = sanitize_key( $schedule );
 		$schedules = wp_get_schedules();
@@ -333,6 +336,9 @@ 
 		) );
 	}
 
+	/**
+	 * @param string $hook
+	 */
 	static function maybe_schedule_sync_cron( $schedule, $hook ) {
 		if ( ! $hook ) {
 			return;

class.jetpack-autoupdate.php

Doc Comments +1 added lines, -1 removed lines

@@ -163,7 +163,7 @@
 	/**
 	 * Iterates through expected items ( plugins or themes ) and compares them to actual results.
 	 *
-	 * @param $items 'plugin' or 'theme'
+	 * @param string $items 'plugin' or 'theme'
 	 */
 	private function log_items( $items ) {
 		if ( ! isset( $this->expected[ $items ] ) ) {

json-endpoints/jetpack/class.jetpack-json-api-sync-endpoint.php

Doc Comments +3 added lines

@@ -227,6 +227,9 @@
 		);
 	}
 
+	/**
+	 * @param Jetpack_Sync_Queue $queue
+	 */
 	protected function get_buffer( $queue, $number_of_items ) {
 		$start = time();
 		$max_duration = 5; // this will try to get the buffer

modules/contact-form/grunion-contact-form.php

Doc Comments +2 added lines, -2 removed lines

@@ -1387,7 +1387,6 @@ 
 	 *
 	 * @see ::style()
 	 * @internal
-	 * @param bool $style
 	 */
 	static function _style_on() {
 		return self::style( true );
@@ -1526,6 +1525,7 @@ 
 	 *
 	 * @param int                         $feedback_id
 	 * @param object Grunion_Contact_Form $form
+	 * @param Grunion_Contact_Form $form
 	 *
 	 * @return string $message
 	 */
@@ -1630,7 +1630,7 @@ 
 	 *
 	 * @param array       $attributes Key => Value pairs as parsed by shortcode_parse_atts()
 	 * @param string|null $content The shortcode's inner content: [contact-field]$content[/contact-field]
-	 * @return HTML for the contact form field
+	 * @return string for the contact form field
 	 */
 	static function parse_contact_field( $attributes, $content ) {
 		// Don't try to parse contact form fields if not inside a contact form