Automattic / jetpack

json-endpoints/jetpack/class.jetpack-json-api-sync-endpoint.php

Doc Comments +3 added lines

@@ -228,6 +228,9 @@
 		);
 	}
 
+	/**
+	 * @param Queue $queue
+	 */
 	protected function get_buffer( $queue, $number_of_items ) {
 		$start = time();
 		$max_duration = 5; // this will try to get the buffer

packages/sync/src/Functions.php

Doc Comments +7 added lines

@@ -148,6 +148,7 @@ 
 	 * Helper function that is used when getting home or siteurl values. Decides
 	 * whether to get the raw or filtered value.
 	 *
+	 * @param string $url_type
 	 * @return string
 	 */
 	public static function get_raw_or_filtered_url( $url_type ) {
@@ -197,6 +198,9 @@ 
 		return self::get_protocol_normalized_url( 'main_network_site_url', network_site_url() );
 	}
 
+	/**
+	 * @param string $callable
+	 */
 	public static function get_protocol_normalized_url( $callable, $new_value ) {
 		$option_key = self::HTTPS_CHECK_OPTION_PREFIX . $callable;
 
@@ -236,6 +240,9 @@ 
 		return $value;
 	}
 
+	/**
+	 * @param string $url_function
+	 */
 	public static function normalize_www_in_url( $option, $url_function ) {
 		$url        = wp_parse_url( call_user_func( $url_function ) );
 		$option_url = wp_parse_url( get_option( $option ) );

packages/sync/src/Listener.php

Doc Comments +3 added lines

@@ -177,6 +177,9 @@
 		$queue->add_all( $data_to_enqueue );
 	}
 
+	/**
+	 * @param Queue $queue
+	 */
 	function enqueue_action( $current_filter, $args, $queue ) {
 		// don't enqueue an action during the outbound http request - this prevents recursion
 		if ( Settings::is_sending() ) {

packages/sync/src/Queue.php

Doc Comments +6 added lines

@@ -240,6 +240,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param Queue_Buffer $buffer
+	 */
 	function close( $buffer, $ids_to_remove = null ) {
 		$is_valid = $this->validate_checkout( $buffer );
 
@@ -344,6 +347,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $checkout_id
+	 */
 	private function set_checkout_id( $checkout_id ) {
 		global $wpdb;
 

packages/options/legacy/class.jetpack-options.php

Doc Comments +10 added lines, -4 removed lines

@@ -16,7 +16,7 @@ 
 	 *
 	 * @param string $type The type of option to return. Defaults to 'compact'.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function get_option_names( $type = 'compact' ) {
 		switch ( $type ) {
@@ -199,6 +199,9 @@ 
 		return $value;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	private static function update_grouped_option( $group, $name, $value ) {
 		$options = get_option( self::$grouped_options[ $group ] );
 		if ( ! is_array( $options ) ) {
@@ -301,6 +304,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	private static function get_grouped_option( $group, $name, $default ) {
 		$options = get_option( self::$grouped_options[ $group ] );
 		if ( is_array( $options ) && isset( $options[ $name ] ) ) {
@@ -420,7 +426,7 @@ 
 	 * This function checks for a constant that, if present, will disable direct DB queries Jetpack uses to manage certain options and force Jetpack to always use Options API instead.
 	 * Options can be selectively managed via a blacklist by filtering option names via the jetpack_disabled_raw_option filter.
 	 *
-	 * @param $name Option name
+	 * @param string $name Option name
 	 *
 	 * @return bool
 	 */
@@ -445,7 +451,7 @@ 
 	 * @since 5.4.0
 	 *
 	 * @param boolean $strip_unsafe_options If true, and by default, will strip out options necessary for the connection to WordPress.com.
-	 * @return array An array of all options managed via the Jetpack_Options class.
+	 * @return string[] An array of all options managed via the Jetpack_Options class.
 	 */
 	static function get_all_jetpack_options( $strip_unsafe_options = true ) {
 		$jetpack_options            = self::get_option_names();
@@ -488,7 +494,7 @@ 
 	 *
 	 * @since 5.4.0
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	static function get_all_wp_options() {
 		// A manual build of the wp options

tools/import-translations.php

Doc Comments +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
 /**
  * Converts GlotPress URL into a GlotPress API URL
  *
- * @param sring $url URL
+ * @param string $url URL
  * @return sstring API URL
  */
 function apize_url( $url ) {

packages/tracking/src/Tracking.php

Doc Comments -1 removed lines

@@ -183,7 +183,6 @@
 	/**
 	 * Record an event in Tracks - this is the preferred way to record events from PHP.
 	 *
-	 * @param mixed  $identity username, user_id, or WP_user object
 	 * @param string $event_name The name of the event
 	 * @param array  $properties Custom properties to send with the event
 	 * @param int    $event_timestamp_millis The time in millis since 1970-01-01 00:00:00 when the event occurred

_inc/lib/plugins.php

Doc Comments +3 added lines

@@ -95,6 +95,9 @@
 		return (array) $upgrader->skin->get_upgrade_messages();
 	}
 
+	 /**
+	  * @param string $plugin_slug
+	  */
 	 protected static function generate_wordpress_org_plugin_download_link( $plugin_slug ) {
 		return "https://downloads.wordpress.org/plugin/$plugin_slug.latest-stable.zip";
 	 }

packages/autoloader/src/AutoloadGenerator.php

Doc Comments +2 added lines, -2 removed lines

@@ -160,7 +160,7 @@ 
 	 * @param string     $vendorPath Path to the vendor directory.
 	 * @param string     $basePath Base Path.
 	 *
-	 * @return array $classMap
+	 * @return string $classMap
 	 */
 	private function getClassMap( array $autoloads, Filesystem $filesystem, $vendorPath, $basePath ) {
 		$blacklist = null;
@@ -224,7 +224,7 @@ 
 	/**
 	 * Generate the PHP that will be used in the autoload_classmap_package.php files.
 	 *
-	 * @param srting $classMap class map array string that is to be written out to the file.
+	 * @param string $classMap class map array string that is to be written out to the file.
 	 *
 	 * @return string
 	 */