Automattic / jetpack

projects/packages/connection/src/class-nonce-handler.php

Doc Comments +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
 	 * @param int $cutoff_timestamp All nonces added before this timestamp will be removed.
 	 * @param int $time_limit How long the cleanup can run (in seconds).
 	 *
-	 * @return true
+	 * @return boolean
 	 */
 	public function clean_all( $cutoff_timestamp = PHP_INT_MAX, $time_limit = 20 ) {
 		// phpcs:ignore Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed

projects/packages/connection/src/class-tokens.php

Doc Comments +1 added lines, -1 removed lines

@@ -246,7 +246,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 function update_user_token( $user_id, $token, $is_master_user ) {
 		// Not designed for concurrent updates.

projects/packages/connection/src/class-manager.php

Doc Comments +3 added lines, -3 removed lines

@@ -293,7 +293,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 ) ) {
@@ -1461,7 +1461,7 @@ 
 	/**
 	 * Obtains the auth token.
 	 *
-	 * @param array $data The request data.
+	 * @param string $data The request data.
 	 * @return object|\WP_Error Returns the auth token on success.
 	 *                          Returns a \WP_Error on failure.
 	 */
@@ -2088,7 +2088,7 @@ 
 	 * @deprecated 9.5 Use Automattic\Jetpack\Connection\Tokens->get_signed_token() instead.
 	 *
 	 * @param object $token the token.
-	 * @return WP_Error|string a signed token
+	 * @return string a signed token
 	 */
 	public function get_signed_token( $token ) {
 		_deprecated_function( __METHOD__, 'jetpack-9.5', 'Automattic\\Jetpack\\Connection\\Tokens->get_signed_token' );

projects/plugins/jetpack/class.jetpack.php

Doc Comments +32 added lines, -16 removed lines

@@ -978,7 +978,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 ) ) {
@@ -1379,7 +1379,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' );
@@ -1489,7 +1489,7 @@ 
 	 *
 	 * @param  bool $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1500,7 +1500,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();
@@ -1563,7 +1563,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' ) ) {
@@ -2271,7 +2271,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-9.5', 'Automattic\\Jetpack\\Connection\\Tokens->update_user_token' );
@@ -2715,7 +2715,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 );
@@ -2830,8 +2830,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.
@@ -2842,6 +2842,10 @@ 
 		return $string;
 	}
 
+	/**
+	 * @param boolean $redirect
+	 * @param boolean $send_state_messages
+	 */
 	public static function activate_default_modules(
 		$min_version = false,
 		$max_version = false,
@@ -3125,6 +3129,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' );
@@ -3153,6 +3160,10 @@ 
 	}
 
 	/* Installation */
+
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 		?>
 <!doctype html>
@@ -3198,6 +3209,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 );
@@ -3915,7 +3927,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();
@@ -4656,6 +4668,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();
@@ -4999,6 +5012,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 );
@@ -5538,7 +5554,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 ) {
@@ -5631,6 +5646,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();
@@ -5712,6 +5728,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -6285,9 +6304,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' ) ) {
@@ -6663,8 +6680,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
 	 */
@@ -6966,7 +6983,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {

projects/plugins/jetpack/_inc/lib/class.jetpack-keyring-service-helper.php

Doc Comments +8 added lines

@@ -136,6 +136,10 @@ 
 		);
 	}
 
+	/**
+	 * @param string $service_name
+	 * @param string $for
+	 */
 	static function refresh_url( $service_name, $for ) {
 		return add_query_arg(
 			array(
@@ -150,6 +154,10 @@ 
 		);
 	}
 
+	/**
+	 * @param string $service_name
+	 * @param string $id
+	 */
 	static function disconnect_url( $service_name, $id ) {
 		return add_query_arg(
 			array(

projects/packages/changelogger/lib/ChangeEntry.php

Doc Comments +1 added lines, -1 removed lines

@@ -165,7 +165,7 @@
 	/**
 	 * Set the timestamp.
 	 *
-	 * @param DateTime|string $timestamp Timestamp to set.
+	 * @param string $timestamp Timestamp to set.
 	 * @returns $this
 	 * @throws InvalidArgumentException If an argument is invalid.
 	 */

projects/packages/changelogger/lib/KeepAChangelogParser.php

Doc Comments +1 added lines

@@ -89,6 +89,7 @@
 	 *
 	 * @param string   $haystack String to split.
 	 * @param string[] ...$needles Strings to split on. Earliest match in $haystack wins.
+	 * @param string $needles
 	 * @return string[] Two elements: The part before $needles and the part after, both trimmed.
 	 */
 	private function split( $haystack, ...$needles ) {

projects/packages/connection/src/class-secrets.php

Doc Comments +1 added lines

@@ -43,6 +43,7 @@
 	 * @param String       $action       The action name.
 	 * @param Integer|bool $user_id The user identifier. Defaults to `false`.
 	 * @param Integer      $exp          Expiration time in seconds.
+	 * @return string|boolean
 	 */
 	public function generate( $action, $user_id = false, $exp = 600 ) {
 		if ( false === $user_id ) {

projects/packages/changelogger/src/Plugins/WordpressVersioning.php

Doc Comments +1 added lines, -1 removed lines

@@ -138,7 +138,7 @@
 	 * Extract the index and count from a prerelease string.
 	 *
 	 * @param string|null $s String.
-	 * @return array Two elements: index and count.
+	 * @return integer[] Two elements: index and count.
 	 * @throws InvalidArgumentException If the string is invalid.
 	 */
 	private function parsePrerelease( $s ) {