Automattic / jetpack

projects/plugins/jetpack/sal/class.json-api-site-base.php

Doc Comments +3 added lines

@@ -23,6 +23,9 @@
 	public $blog_id;
 	public $platform;
 
+	/**
+	 * @param WPORG_Platform $platform
+	 */
 	public function __construct( $blog_id, $platform ) {
 		$this->blog_id = $blog_id;
 		$this->platform = $platform;

projects/plugins/jetpack/sal/class.json-api-site-jetpack-base.php

Doc Comments +13 added lines

@@ -4,10 +4,20 @@ 
 require_once dirname( __FILE__ ) . '/class.json-api-site-base.php';
 
 abstract class Abstract_Jetpack_Site extends SAL_Site {
+
+	/**
+	 * @param string $name
+	 */
 	abstract protected function get_constant( $name );
 
+	/**
+	 * @param string $feature_name
+	 */
 	abstract protected function current_theme_supports( $feature_name );
 
+	/**
+	 * @param string $feature_name
+	 */
 	abstract protected function get_theme_support( $feature_name );
 
 	abstract protected function get_mock_option( $name );
@@ -16,6 +26,9 @@ 
 
 	abstract public function get_updates();
 
+	/**
+	 * @return string
+	 */
 	abstract protected function main_network_site();
 
 	abstract protected function wp_version();

projects/packages/sync/src/interface-replicastore.php

Doc Comments +30 added lines

@@ -20,6 +20,7 @@ 
 	 * Empty and reset the replicastore.
 	 *
 	 * @access public
+	 * @return void
 	 */
 	public function reset();
 
@@ -29,6 +30,7 @@ 
 	 * @access public
 	 *
 	 * @param array $config Full sync configuration for this sync module.
+	 * @return void
 	 */
 	public function full_sync_start( $config );
 
@@ -38,6 +40,7 @@ 
 	 * @access public
 	 *
 	 * @param string $checksum Deprecated since 7.3.0.
+	 * @return void
 	 */
 	public function full_sync_end( $checksum );
 
@@ -51,6 +54,7 @@ 
 	 * @param string $status Post status.
 	 * @param int    $min_id Minimum post ID.
 	 * @param int    $max_id Maximum post ID.
+	 * @return integer
 	 */
 	public function post_count( $status = null, $min_id = null, $max_id = null );
 
@@ -81,6 +85,7 @@ 
 	 *
 	 * @param \WP_Post $post   Post object.
 	 * @param bool     $silent Whether to perform a silent action.
+	 * @return void
 	 */
 	public function upsert_post( $post, $silent = false );
 
@@ -90,6 +95,7 @@ 
 	 * @access public
 	 *
 	 * @param int $post_id Post ID.
+	 * @return void
 	 */
 	public function delete_post( $post_id );
 
@@ -121,6 +127,7 @@ 
 	 * @param string $status Comment status.
 	 * @param int    $min_id Minimum comment ID.
 	 * @param int    $max_id Maximum comment ID.
+	 * @return integer
 	 */
 	public function comment_count( $status = null, $min_id = null, $max_id = null );
 
@@ -150,6 +157,7 @@ 
 	 * @access public
 	 *
 	 * @param \WP_Comment $comment Comment object.
+	 * @return void
 	 */
 	public function upsert_comment( $comment );
 
@@ -159,6 +167,7 @@ 
 	 * @access public
 	 *
 	 * @param int $comment_id Comment ID.
+	 * @return void
 	 */
 	public function trash_comment( $comment_id );
 
@@ -168,6 +177,7 @@ 
 	 * @access public
 	 *
 	 * @param int $comment_id Comment ID.
+	 * @return void
 	 */
 	public function spam_comment( $comment_id );
 
@@ -177,6 +187,7 @@ 
 	 * @access public
 	 *
 	 * @param int $comment_id Comment ID.
+	 * @return void
 	 */
 	public function delete_comment( $comment_id );
 
@@ -187,6 +198,7 @@ 
 	 *
 	 * @param int   $post_id  Post ID.
 	 * @param array $statuses Post statuses.
+	 * @return void
 	 */
 	public function trashed_post_comments( $post_id, $statuses );
 
@@ -196,6 +208,7 @@ 
 	 * @access public
 	 *
 	 * @param int $post_id Post ID.
+	 * @return void
 	 */
 	public function untrashed_post_comments( $post_id );
 
@@ -226,6 +239,7 @@ 
 	 *
 	 * @param string $option Option name.
 	 * @param mixed  $value  Option value.
+	 * @return boolean|null
 	 */
 	public function update_option( $option, $value );
 
@@ -245,6 +259,7 @@ 
 	 * @access public
 	 *
 	 * @param string $option Name of option to remove.
+	 * @return boolean|null
 	 */
 	public function delete_option( $option );
 
@@ -254,6 +269,7 @@ 
 	 * @access public
 	 *
 	 * @param array $theme_info Theme info array.
+	 * @return void
 	 */
 	public function set_theme_info( $theme_info );
 
@@ -288,6 +304,7 @@ 
 	 * @param string $meta_key   Meta key.
 	 * @param mixed  $meta_value Meta value.
 	 * @param int    $meta_id    ID of the meta.
+	 * @return boolean|null
 	 */
 	public function upsert_metadata( $type, $object_id, $meta_key, $meta_value, $meta_id );
 
@@ -299,6 +316,7 @@ 
 	 * @param string $type      Meta type.
 	 * @param int    $object_id ID of the object.
 	 * @param array  $meta_ids  IDs of the meta objects to delete.
+	 * @return false|null
 	 */
 	public function delete_metadata( $type, $object_id, $meta_ids );
 
@@ -310,6 +328,7 @@ 
 	 * @param string $type       Meta type.
 	 * @param array  $object_ids IDs of the objects.
 	 * @param string $meta_key   Meta key.
+	 * @return false|null
 	 */
 	public function delete_batch_metadata( $type, $object_ids, $meta_key );
 
@@ -350,6 +369,7 @@ 
 	 *
 	 * @param string $type    Type of updates to set.
 	 * @param int    $updates Total number of updates.
+	 * @return void
 	 */
 	public function set_updates( $type, $updates );
 
@@ -369,6 +389,7 @@ 
 	 *
 	 * @param string $callable Callable name.
 	 * @param mixed  $value    Callable value.
+	 * @return void
 	 */
 	public function set_callable( $callable, $value );
 
@@ -388,6 +409,7 @@ 
 	 *
 	 * @param string $option Network option name.
 	 * @param mixed  $value  Network option value.
+	 * @return boolean|null
 	 */
 	public function update_site_option( $option, $value );
 
@@ -397,6 +419,7 @@ 
 	 * @access public
 	 *
 	 * @param string $option Name of option to remove.
+	 * @return boolean|null
 	 */
 	public function delete_site_option( $option );
 
@@ -458,6 +481,7 @@ 
 	 * @param string           $taxonomy  The context in which to relate the term to the object.
 	 * @param string|int|array $terms     A single term slug, single term id, or array of either term slugs or ids.
 	 * @param bool             $append    Optional. If false will delete difference of terms. Default false.
+	 * @return void
 	 */
 	public function update_object_terms( $object_id, $taxonomy, $terms, $append );
 
@@ -470,6 +494,7 @@ 
 	 *
 	 * @param int   $object_id ID of the object.
 	 * @param array $tt_ids    Term taxonomy IDs.
+	 * @return boolean|null
 	 */
 	public function delete_object_terms( $object_id, $tt_ids );
 
@@ -477,6 +502,7 @@ 
 	 * Retrieve the number of users.
 	 *
 	 * @access public
+	 * @return null|integer
 	 */
 	public function user_count();
 
@@ -495,6 +521,7 @@ 
 	 * @access public
 	 *
 	 * @param \WP_User $user User object.
+	 * @return void
 	 */
 	public function upsert_user( $user );
 
@@ -504,6 +531,7 @@ 
 	 * @access public
 	 *
 	 * @param int $user_id User ID.
+	 * @return void
 	 */
 	public function delete_user( $user_id );
 
@@ -514,6 +542,7 @@ 
 	 *
 	 * @param int    $user_id User ID.
 	 * @param string $locale  The user locale.
+	 * @return void
 	 */
 	public function upsert_user_locale( $user_id, $locale );
 
@@ -523,6 +552,7 @@ 
 	 * @access public
 	 *
 	 * @param int $user_id User ID.
+	 * @return void
 	 */
 	public function delete_user_locale( $user_id );
 

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

Doc Comments +5 added lines, -5 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;
@@ -124,7 +124,7 @@ 
 	 *
 	 * @access public
 	 *
-	 * @param array   $config               Full sync configuration for this sync module.
+	 * @param boolean   $config               Full sync configuration for this sync module.
 	 * @param int     $max_items_to_enqueue Maximum number of items to enqueue.
 	 * @param boolean $state                True if full sync has finished enqueueing this module, false otherwise.
 	 * @return array  Number of actions enqueued, and next module state.
@@ -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 ) );
@@ -285,7 +285,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.
 	 *

projects/plugins/jetpack/_inc/lib/core-api/class-wpcom-rest-field-controller.php

Doc Comments +2 added lines, -2 removed lines

@@ -109,9 +109,9 @@
 	 *
 	 * This cannot be extended: implement `->get()` instead.
 	 *
-	 * @param mixed           $object_data Probably an array. Whatever the endpoint returns.
+	 * @param integer           $object_data Probably an array. Whatever the endpoint returns.
 	 * @param string          $field_name Should always match `->field_name`
-	 * @param WP_REST_Request $request
+	 * @param integer $request
 	 * @param string          $object_type Should always match `->object_type`
 	 * @return mixed
 	 */

projects/plugins/jetpack/_inc/lib/core-api/load-wpcom-endpoints.php

Doc Comments +6 added lines

@@ -15,6 +15,9 @@ 
 	exit;
 }
 
+/**
+ * @param string $file_pattern
+ */
 function wpcom_rest_api_v2_load_plugin_files( $file_pattern ) {
 	$plugins = glob( dirname( __FILE__ ) . '/' . $file_pattern );
 
@@ -28,6 +31,9 @@ 
 }
 
 // API v2 plugins: define a class, then call this function.
+/**
+ * @param string $class_name
+ */
 function wpcom_rest_api_v2_load_plugin( $class_name ) {
 	global $wpcom_rest_api_v2_plugins;
 

projects/plugins/jetpack/class.jetpack-network.php

Doc Comments +1 added lines, -1 removed lines

@@ -389,7 +389,7 @@
 	/**
 	 * Set the disconnect capability for multisite.
 	 *
-	 * @param array $caps The capabilities array.
+	 * @param string[] $caps The capabilities array.
 	 */
 	public function set_multisite_disconnect_cap( $caps ) {
 		// Can individual site admins manage their own connection?

projects/plugins/jetpack/class.jetpack-post-images.php

Doc Comments -1 removed lines

@@ -687,7 +687,6 @@
 	 * resized and cropped image.
 	 *
 	 * @param  string $src
-	 * @param  int    $dimension
 	 * @return string            Transformed image URL
 	 */
 	static function fit_image_url( $src, $width, $height ) {

projects/plugins/jetpack/class.jetpack.php

Doc Comments +36 added lines, -17 removed lines

@@ -956,7 +956,7 @@ 
 	 * This is ported over from the manage module, which has been deprecated and baked in here.
 	 *
 	 * @param $domains
-	 * @return array
+	 * @return string[]
 	 */
 	function allow_wpcom_domain( $domains ) {
 		if ( empty( $domains ) ) {
@@ -1324,7 +1324,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' );
@@ -1434,7 +1434,7 @@ 
 	 *
 	 * @param  bool $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1445,7 +1445,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();
@@ -1508,7 +1508,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' ) ) {
@@ -2237,7 +2237,7 @@ 
 	 * @param int    $user_id The user id.
 	 * @param string $token The user token.
 	 * @param bool   $is_master_user Whether the user is the master user.
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public static function update_user_token( $user_id, $token, $is_master_user ) {
 		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
@@ -2681,7 +2681,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 );
@@ -2796,8 +2796,8 @@ 
 	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
 	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
 	 *
-	 * @param $string
-	 * @return mixed
+	 * @param string $string
+	 * @return string|null
 	 */
 	public static function alias_directories( $string ) {
 		// ABSPATH has a trailing slash.
@@ -2808,6 +2808,10 @@ 
 		return $string;
 	}
 
+	/**
+	 * @param boolean $redirect
+	 * @param boolean $send_state_messages
+	 */
 	public static function activate_default_modules(
 		$min_version = false,
 		$max_version = false,
@@ -3091,6 +3095,9 @@ 
 		return self::update_active_modules( $new );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function enable_module_configurable( $module ) {
 		$module = self::get_module_slug( $module );
 		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
@@ -3119,6 +3126,10 @@ 
 	}
 
 	/* Installation */
+
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 		?>
 <!doctype html>
@@ -3164,6 +3175,7 @@ 
 	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
 	 *
 	 * @static
+	 * @param boolean $network_wide
 	 */
 	public static function plugin_activation( $network_wide ) {
 		Jetpack_Options::update_option( 'activated', 1 );
@@ -3884,7 +3896,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();
@@ -4588,6 +4600,7 @@ 
 
 	/**
 	 * Record a stat for later output.  This will only currently output in the admin_footer.
+	 * @param string $group
 	 */
 	function stat( $group, $detail ) {
 		$this->initialize_stats();
@@ -5001,6 +5014,9 @@ 
 		return $url;
 	}
 
+	/**
+	 * @param string $actionurl
+	 */
 	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
 		$actionurl = str_replace( '&amp;', '&', $actionurl );
 		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
@@ -5291,12 +5307,15 @@ 
 	 * @param String  $action  The action name.
 	 * @param Integer $user_id The user identifier.
 	 * @param Integer $exp     Expiration time in seconds.
-	 * @return array
+	 * @return boolean
 	 */
 	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
 		return self::connection()->generate_secrets( $action, $user_id, $exp );
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public static function get_secrets( $action, $user_id ) {
 		$secrets = self::connection()->get_secrets( $action, $user_id );
 
@@ -5547,7 +5566,6 @@ 
 	 * @deprecated since 8.9.0
 	 * @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authentication_errors()
 	 *
-	 * @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 ) {
@@ -5640,6 +5658,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();
@@ -5721,6 +5740,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -6293,9 +6315,7 @@ 
 	 *
 	 * Attached to `style_loader_src` filter.
 	 *
-	 * @param string $tag The tag that would link to the external asset.
 	 * @param string $handle The registered handle of the script in question.
-	 * @param string $href The url of the asset in question.
 	 */
 	public static function set_suffix_on_min( $src, $handle ) {
 		if ( false === strpos( $src, '.min.css' ) ) {
@@ -6671,8 +6691,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
 	 */
@@ -6971,7 +6991,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {