Automattic / jetpack

projects/packages/analyzer/src/class-differences.php

Doc Comments +3 added lines

@@ -9,6 +9,9 @@
 
 class Differences extends PersistentList {
 
+	/**
+	 * @param string $path
+	 */
 	private function slashit( $path ) {
 		$path .= ( substr( $path, -1 ) == '/' ? '' : '/' );
 		return $path;

projects/packages/analyzer/src/class-invocations.php

Doc Comments +3 added lines

@@ -37,6 +37,9 @@
 		}
 	}
 
+	/**
+	 * @param string $root
+	 */
 	public function scan_dir( $root, $exclude = array() ) {
 		$filter = function ( $file, $key, $iterator ) use ( $exclude ) {
 			if ( $iterator->hasChildren() && ! in_array( $file->getFilename(), $exclude ) ) {

projects/packages/analyzer/src/class-PersistentList.php

Doc Comments +1 added lines

@@ -31,6 +31,7 @@
 
 	/**
 	 * Saves the items to a file and returns the file contents
+	 * @param string $file_path
 	 */
 	public function save( $file_path, $allow_empty = true ) {
 

projects/packages/analyzer/src/Declarations/class-visitor.php

Doc Comments +3 added lines

@@ -11,6 +11,9 @@
 	private $declarations;
 	private $current_relative_path;
 
+	/**
+	 * @param  $declarations
+	 */
 	public function __construct( $current_relative_path, $declarations ) {
 		$this->current_relative_path = $current_relative_path;
 		$this->declarations          = $declarations;

projects/packages/analyzer/src/Invocations/class-visitor.php

Doc Comments +3 added lines

@@ -9,6 +9,9 @@
 	private $invocations;
 	private $file_path;
 
+	/**
+	 * @param  $invocations
+	 */
 	public function __construct( $file_path, $invocations ) {
 		$this->file_path   = $file_path;
 		$this->invocations = $invocations;

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

Doc Comments +4 added lines, -3 removed lines

@@ -313,7 +313,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 ) ) {
@@ -1286,6 +1286,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 ) {
@@ -2242,7 +2243,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
 	 */
@@ -2626,7 +2627,7 @@ 
 	 * Fetches a signed token.
 	 *
 	 * @param object $token the token.
-	 * @return WP_Error|string a signed token
+	 * @return string a signed token
 	 */
 	public function get_signed_token( $token ) {
 		if ( ! isset( $token->secret ) || empty( $token->secret ) ) {

projects/packages/sync/src/class-actions.php

Doc Comments +3 added lines, -3 removed lines

@@ -336,7 +336,7 @@ 
 	 * @access public
 	 * @static
 	 *
-	 * @return bool|null False if sync is not allowed.
+	 * @return false|null False if sync is not allowed.
 	 */
 	public static function do_initial_sync() {
 		// Lets not sync if we are not suppose to.
@@ -506,7 +506,7 @@ 
 	 * @static
 	 *
 	 * @param array $sync_modules The list of sync modules declared prior to this filter.
-	 * @return array A list of sync modules that now includes Woo's modules.
+	 * @return string[] A list of sync modules that now includes Woo's modules.
 	 */
 	public static function add_woocommerce_sync_module( $sync_modules ) {
 		$sync_modules[] = 'Automattic\\Jetpack\\Sync\\Modules\\WooCommerce';
@@ -533,7 +533,7 @@ 
 	 * @static
 	 *
 	 * @param array $sync_modules The list of sync modules declared prior to this filer.
-	 * @return array A list of sync modules that now includes WP Super Cache's modules.
+	 * @return string[] A list of sync modules that now includes WP Super Cache's modules.
 	 */
 	public static function add_wp_super_cache_sync_module( $sync_modules ) {
 		$sync_modules[] = 'Automattic\\Jetpack\\Sync\\Modules\\WP_Super_Cache';

projects/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 ) );

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

Doc Comments +2 added lines, -2 removed lines

@@ -222,7 +222,7 @@ 
 	 * @access public
 	 *
 	 * @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;
@@ -233,7 +233,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_callables' );