Automattic / jetpack

packages/sync/src/modules/class-constants.php

Doc Comments +2 added lines, -2 removed lines

@@ -158,7 +158,7 @@ 
 	 *
 	 * @param array $config Full sync configuration for this sync module.
 	 *
-	 * @return array Number of items yet to be enqueued.
+	 * @return integer Number of items yet to be enqueued.
 	 */
 	public function estimate_full_sync_actions( $config ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
 		return 1;
@@ -169,7 +169,7 @@ 
 	 *
 	 * @access public
 	 *
-	 * @return array Full sync actions of this module.
+	 * @return string[] Full sync actions of this module.
 	 */
 	public function get_full_sync_actions() {
 		return array( 'jetpack_full_sync_constants' );

packages/connection/src/class-manager.php

Doc Comments +4 added lines, -3 removed lines

@@ -273,7 +273,7 @@ 
 	/**
 	 * Verifies the signature of the current request.
 	 *
-	 * @return false|array
+	 * @return boolean
 	 */
 	public function verify_xml_rpc_signature() {
 		if ( is_null( $this->xmlrpc_verification ) ) {
@@ -637,7 +637,7 @@ 
 	 * @param Integer $user_id (optional) the user identifier, defaults to current user.
 	 * @param String  $redirect_url the URL to redirect the user to for processing, defaults to
 	 *                              admin_url().
-	 * @return WP_Error only in case of a failed user lookup.
+	 * @return \WP_Error|null only in case of a failed user lookup.
 	 */
 	public function connect_user( $user_id = null, $redirect_url = null ) {
 		$user = null;
@@ -1167,6 +1167,7 @@ 
 	 * @param String  $action  The action name.
 	 * @param Integer $user_id The user identifier.
 	 * @param Integer $exp     Expiration time in seconds.
+	 * @return string
 	 */
 	public function generate_secrets( $action, $user_id = false, $exp = 600 ) {
 		if ( false === $user_id ) {
@@ -1660,7 +1661,7 @@ 
 	 *
 	 * @param int|false    $user_id   false: Return the Blog Token. int: Return that user's User Token.
 	 * @param string|false $token_key If provided, check that the token matches the provided input.
-	 * @param bool|true    $suppress_errors If true, return a falsy value when the token isn't found; When false, return a descriptive WP_Error when the token isn't found.
+	 * @param boolean    $suppress_errors If true, return a falsy value when the token isn't found; When false, return a descriptive WP_Error when the token isn't found.
 	 *
 	 * @return object|false
 	 */

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

Doc Comments +1 added lines, -1 removed lines

@@ -231,7 +231,7 @@
 	/**
 	 * Filter and replace HTML element.
 	 *
-	 * @param array  $matches Array of matches.
+	 * @param string[]  $matches Array of matches.
 	 * @param string $orig_html Original html. Returned if no results are found via $matches processing.
 	 */
 	private static function dispatch( $matches, $orig_html = null ) {

packages/sync/src/modules/class-module.php

Doc Comments +4 added lines, -4 removed lines

@@ -67,7 +67,7 @@ 
 	 *
 	 * @param string $object_type Type of the sync object.
 	 * @param int    $id          ID of the sync object.
-	 * @return mixed Object, or false if the object is invalid.
+	 * @return boolean Object, or false if the object is invalid.
 	 */
 	public function get_object_by_id( $object_type, $id ) {
 		return false;
@@ -166,8 +166,8 @@ 
 	 * @access protected
 	 *
 	 * @param array $action_names     Action names we're interested in.
-	 * @param array $actions_to_count Unfiltered list of actions we want to count.
-	 * @return array Number of actions that we're interested in.
+	 * @param string[] $actions_to_count Unfiltered list of actions we want to count.
+	 * @return integer Number of actions that we're interested in.
 	 */
 	protected function count_actions( $action_names, $actions_to_count ) {
 		return count( array_intersect( $action_names, $actions_to_count ) );
@@ -266,7 +266,7 @@ 
 	/**
 	 * Given the Module Full Sync Configuration and Status return the next chunk of items to send.
 	 *
-	 * @param array $config This module Full Sync configuration.
+	 * @param string $config This module Full Sync configuration.
 	 * @param array $status This module Full Sync status.
 	 * @param int   $chunk_size Chunk size.
 	 *

packages/status/tests/php/test_Status.php

Doc Comments +2 added lines, -3 removed lines

@@ -205,8 +205,7 @@ 
 	/**
 	 * Mock a set of constants.
 	 *
-	 * @param array $args Array of sets with constants and their respective values.
-	 * @return phpmock\Mock The mock object.
+	 * @return phpmock\Mock[] The mock object.
 	 */
 	protected function mock_constants( $constants = array() ) {
 		$prepare_constant = function( $constant ) {
@@ -222,7 +221,7 @@ 
 	/**
 	 * Mock $wpdb->get_var() and make it return a certain value.
 	 *
-	 * @param mixed  $return_value  Return value of the function.
+	 * @param integer  $return_value  Return value of the function.
 	 * @return PHPUnit\Framework\MockObject\MockObject The mock object.
 	 */
 	protected function mock_wpdb_get_var( $return_value = null ) {

_inc/lib/core-api/load-wpcom-endpoints.php

Doc Comments +3 added lines

@@ -8,6 +8,9 @@
  *  - wp-content/rest-api-plugins/jetpack-endpoints/
  */
 
+/**
+ * @param string $file_pattern
+ */
 function wpcom_rest_api_v2_load_plugin_files( $file_pattern ) {
 	$plugins = glob( dirname( __FILE__ ) . '/' . $file_pattern );
 

packages/sync/src/class-functions.php

Doc Comments +4 added lines, -4 removed lines

@@ -181,7 +181,7 @@ 
 	/**
 	 * Return a hosting provider using a set of known constants.
 	 *
-	 * @return mixed A host identifier string or false.
+	 * @return string|false A host identifier string or false.
 	 */
 	public function get_hosting_provider_by_known_constant() {
 		$hosting_provider_constants = array(
@@ -209,7 +209,7 @@ 
 	/**
 	 * Return a hosting provider using a set of known classes.
 	 *
-	 * @return mixed A host identifier string or false.
+	 * @return string|false A host identifier string or false.
 	 */
 	public function get_hosting_provider_by_known_class() {
 		$hosting_provider = false;
@@ -226,7 +226,7 @@ 
 	/**
 	 * Return a hosting provider using a set of known functions.
 	 *
-	 * @return mixed A host identifier string or false.
+	 * @return string|false A host identifier string or false.
 	 */
 	public function get_hosting_provider_by_known_function() {
 		$hosting_provider = false;
@@ -441,7 +441,7 @@ 
 	 *
 	 * @param string   $option Option value from the site.
 	 * @param callable $url_function Function retrieving the URL to normalize.
-	 * @return mixed|string URL.
+	 * @return callable URL.
 	 */
 	public static function normalize_www_in_url( $option, $url_function ) {
 		$url        = wp_parse_url( call_user_func( $url_function ) );

packages/sync/src/class-listener.php

Doc Comments +2 added lines, -2 removed lines

@@ -157,7 +157,7 @@ 
 	 * Prevent adding items to the queue if it hasn't sent an item for 15 mins
 	 * AND the queue is over 1000 items long (by default).
 	 *
-	 * @param object $queue Sync queue.
+	 * @param string $queue Sync queue.
 	 * @return bool
 	 */
 	public function can_add_to_queue( $queue ) {
@@ -360,7 +360,7 @@ 
 	 * Sync Data Loss Handler
 	 *
 	 * @param Queue $queue Sync queue.
-	 * @return boolean was send successful
+	 * @return null|Items was send successful
 	 */
 	public function sync_data_loss( $queue ) {
 		if ( ! Settings::is_sync_enabled() ) {

class.json-api.php

Doc Comments +18 added lines, -1 removed lines

@@ -35,6 +35,9 @@ 
 	public $amp_source_origin = null;
 
 	/**
+	 * @param string $method
+	 * @param string $url
+	 * @param string $post_body
 	 * @return WPCOM_JSON_API instance
 	 */
 	static function init( $method = null, $url = null, $post_body = null ) {
@@ -348,6 +351,9 @@ 
 		return call_user_func_array( array( $endpoint, 'callback' ), $path_pieces );
 	}
 
+	/**
+	 * @param integer $status_code
+	 */
 	function output_early( $status_code, $response = null, $content_type = 'application/json' ) {
 		$exit       = $this->exit;
 		$this->exit = false;
@@ -572,11 +578,18 @@ 
 		return wp_json_encode( $data );
 	}
 
+	/**
+	 * @param string $needle
+	 */
 	function ends_with( $haystack, $needle ) {
 		return $needle === substr( $haystack, -strlen( $needle ) );
 	}
 
 	// Returns the site's blog_id in the WP.com ecosystem
+
+	/**
+	 * @return integer
+	 */
 	function get_blog_id_for_output() {
 		return $this->token_details['blog_id'];
 	}
@@ -599,6 +612,10 @@ 
 	}
 
 	// Returns true if the specified blog ID is a restricted blog
+
+	/**
+	 * @param integer $blog_id
+	 */
 	function is_restricted_blog( $blog_id ) {
 		/**
 		 * Filters all REST API access and return a 403 unauthorized response for all Restricted blog IDs.
@@ -648,7 +665,7 @@ 
 	/**
 	 * Counts the number of comments on a site, excluding certain comment types.
 	 *
-	 * @param $post_id int Post ID.
+	 * @param integer $post_id int Post ID.
 	 * @return array Array of counts, matching the output of https://developer.wordpress.org/reference/functions/get_comment_count/.
 	 */
 	public function wp_count_comments( $post_id ) {