Automattic / jetpack

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/wordads/php/api.php

Doc Comments +3 added lines, -3 removed lines

@@ -45,7 +45,7 @@ 
 
 	/**
 	 * Returns status of WordAds approval.
-	 * @return boolean true if site is WordAds approved
+	 * @return string true if site is WordAds approved
 	 *
 	 * @since 4.5.0
 	 */
@@ -59,7 +59,7 @@ 
 
 	/**
 	 * Returns status of WordAds active.
-	 * @return boolean true if ads are active on site
+	 * @return string true if ads are active on site
 	 *
 	 * @since 4.5.0
 	 */
@@ -73,7 +73,7 @@ 
 
 	/**
 	 * Returns status of WordAds house ads.
-	 * @return boolean true if WP.com house ads should be shown
+	 * @return string true if WP.com house ads should be shown
 	 *
 	 * @since 4.5.0
 	 */

modules/shortcodes/class.filter-embedded-html-objects.php

Doc Comments +6 added lines

@@ -90,6 +90,9 @@ 
 		return $html;
 	}
 
+	/**
+	 * @param string $regexp
+	 */
 	static public function regexp_entities( $regexp ) {
 		return preg_replace(
 			'/\[\^&([^\]]+)\]\*\+/',
@@ -128,6 +131,9 @@ 
 		return self::dispatch( $matches );
 	}
 
+	/**
+	 * @param string[] $matches
+	 */
 	static function dispatch( $matches ) {
 		$html  = preg_replace( '%&#0*58;//%', '://', $matches[0] );
 		$attrs = self::get_attrs( $html );

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;

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.php

Doc Comments +43 added lines, -13 removed lines

@@ -893,7 +893,7 @@ 
 	}
 	/**
 	 * Does the network allow admins to add new users.
-	 * @return boolian
+	 * @return boolean
 	 */
 	static function network_add_new_users( $option = null ) {
 		return (bool) get_site_option( 'add_new_users' );
@@ -998,7 +998,7 @@ 
 	 * database which could be set to anything as opposed to what this function returns.
 	 * @param  bool  $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1009,7 +1009,7 @@ 
 	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
 	 *
 	 * @param  string  $option
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_multisite( $option ) {
 		return (string) (bool) is_multisite();
@@ -1071,7 +1071,7 @@ 
 
 	/**
 	 * Returns true if the site has file write access false otherwise.
-	 * @return string ( '1' | '0' )
+	 * @return integer ( '1' | '0' )
 	 **/
 	public static function file_system_write_access() {
 		if ( ! function_exists( 'get_filesystem_method' ) ) {
@@ -1280,6 +1280,7 @@ 
 	 * @access public
 	 * @static
 	 *
+	 * @param string $feature
 	 * @return bool True if plan supports feature, false if not
 	 */
 	public static function active_plan_supports( $feature ) {
@@ -1779,6 +1780,7 @@ 
 	* Stores two secrets and a timestamp so WordPress.com can make a request back and verify an action
 	* Does some extra verification so urls (such as those to public-api, register, etc) can't just be crafted
 	* $name must be a registered option name.
+	* @param string $name
 	*/
 	public static function create_nonce( $name ) {
 		$secret = wp_generate_password( 32, false ) . ':' . wp_generate_password( 32, false ) . ':' . ( time() + 600 );
@@ -1836,6 +1838,7 @@ 
 	 * @param int $user_id
 	 * @param string $token
 	 * return bool
+	 * @param boolean $is_master_user
 	 */
 	public static function update_user_token( $user_id, $token, $is_master_user ) {
 		// not designed for concurrent updates
@@ -2230,6 +2233,7 @@ 
 
 	/**
 	 * Like core's get_file_data implementation, but caches the result.
+	 * @param string $file
 	 */
 	public static function get_file_data( $file, $headers ) {
 		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
@@ -2258,7 +2262,7 @@ 
 	 *
 	 * @param string $tag Tag as it appears in each module heading.
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public static function translate_module_tag( $tag ) {
 		return jetpack_get_module_i18n_tag( $tag );
@@ -2271,7 +2275,7 @@ 
 	 *
 	 * @param array $modules
 	 *
-	 * @return string|void
+	 * @return string
 	 */
 	public static function get_translated_modules( $modules ) {
 		foreach ( $modules as $index => $module ) {
@@ -2600,6 +2604,9 @@ 
 		return self::update_active_modules( $new );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function enable_module_configurable( $module ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
@@ -2610,21 +2617,33 @@ 
 		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_load( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'jetpack_module_configuration_load_' . $module, $method );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_head( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'jetpack_module_configuration_head_' . $module, $method );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_screen( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_activation_screen( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'display_activate_module_setting_' . $module, $method );
@@ -2632,6 +2651,9 @@ 
 
 /* Installation */
 
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3280,7 +3302,7 @@ 
 	 * Add help to the Jetpack page
 	 *
 	 * @since Jetpack (1.2.3)
-	 * @return false if not the Jetpack page
+	 * @return false|null if not the Jetpack page
 	 */
 	function admin_help() {
 		$current_screen = get_current_screen();
@@ -4278,6 +4300,7 @@ 
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -4422,7 +4445,8 @@ 
 	 * Note these tokens are unique per call, NOT static per site for connecting.
 	 *
 	 * @since 2.6
-	 * @return array
+	 * @param string $action
+	 * @return string
 	 */
 	public function generate_secrets( $action, $exp = 600 ) {
 	    $secret = wp_generate_password( 32, false ) // secret_1
@@ -4849,7 +4873,6 @@ 
 	/**
 	 * Report authentication status to the WP REST API.
 	 *
-	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
 	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
 	 */
 	public function wp_rest_authentication_errors( $value ) {
@@ -4859,6 +4882,10 @@ 
 		return $this->rest_authentication_status;
 	}
 
+	/**
+	 * @param integer $timestamp
+	 * @param string $nonce
+	 */
 	function add_nonce( $timestamp, $nonce ) {
 		global $wpdb;
 		static $nonces_used_this_request = array();
@@ -5004,6 +5031,7 @@ 
 	 * @param string $key
 	 * @param string $value
 	 * @param bool $restate private
+	 * @return string
 	 */
 	public static function state( $key = null, $value = null, $restate = false ) {
 		static $state = array();
@@ -5060,6 +5088,9 @@ 
 		Jetpack::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -5809,8 +5840,8 @@ 
 	 *  - Absolute URLs             `http://domain.com/feh.png`
 	 *  - Domain root relative URLs `/feh.png`
 	 *
-	 * @param $css string: The raw CSS -- should be read in directly from the file.
-	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
+	 * @param string $css string: The raw CSS -- should be read in directly from the file.
+	 * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
 	 *
 	 * @return mixed|string
 	 */
@@ -6101,7 +6132,7 @@ 
 	 *
 	 * @param string $option_name
 	 *
-	 * @return bool
+	 * @return false|null
 	 */
 	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
 		// Bail if Jump Start has already been dismissed
@@ -6192,7 +6223,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {

_inc/lib/class.core-rest-api-endpoints.php

Doc Comments +7 added lines, -2 removed lines

@@ -283,6 +283,11 @@ 
 		) );
 	}
 
+	/**
+	 * @param string $path
+	 * @param string $classname
+	 * @param Jetpack_IXR_Client $constructor_arguments
+	 */
 	public static function route( $path, $classname, $method,
 		$constructor_arguments = NULL,
 		$endpoint_arguments = NULL
@@ -1980,7 +1985,7 @@ 
 	 *
 	 * @param string $route Regular expression for the endpoint with the module slug to return.
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public static function get_module_requested( $route = '/module/(?P<slug>[a-z\-]+)' ) {
 
@@ -2005,7 +2010,7 @@ 
 	 * @param string      $modules Can be a single module or a list of modules.
 	 * @param null|string $slug    Slug of the module in the first parameter.
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public static function prepare_modules_for_response( $modules = '', $slug = null ) {
 		if ( get_option( 'permalink_structure' ) ) {

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/class.wpcom-json-api-site-user-endpoint.php

Doc Comments +1 added lines

@@ -64,6 +64,7 @@
 	/**
 	 * Updates user data
 	 *
+	 * @param integer $user_id
 	 * @return (array)
 	 */
 	public function update_user( $user_id, $blog_id ) {