Automattic / jetpack

class.json-api-endpoints.php

Doc Comments +6 added lines, -1 removed lines

@@ -1540,6 +1540,7 @@ 
 	 * timezone set in the options table for the blog or the GMT offset.
 	 *
 	 * @param datetime string $date_string Date to parse.
+	 * @param string $date_string
 	 *
 	 * @return array( $local_time_string, $gmt_time_string )
 	 */
@@ -1649,6 +1650,10 @@ 
 		do_action( 'restapi_theme_init' );
 	}
 
+	/**
+	 * @param string $from_hook
+	 * @param string $to_hook
+	 */
 	function copy_hooks( $from_hook, $to_hook, $base_paths ) {
 		global $wp_filter;
 		foreach ( $wp_filter as $hook => $actions ) {
@@ -2073,7 +2078,7 @@ 
 	 * Get an array of all valid AMP origins for a blog's siteurl.
 	 *
 	 * @param string $siteurl Origin url of the API request.
-	 * @return array
+	 * @return string[]
 	 */
 	public function get_amp_cache_origins( $siteurl ) {
 		$host = parse_url( $siteurl, PHP_URL_HOST );

sal/class.json-api-site-jetpack.php

Doc Comments +6 added lines

@@ -165,6 +165,9 @@ 
 		return $this->get_atomic_cloud_site_option( 'launch-status' );
 	}
 
+	/**
+	 * @param string $option
+	 */
 	function get_atomic_cloud_site_option( $option ) {
 		if ( ! jetpack_is_atomic_site() ) {
 			return false;
@@ -233,6 +236,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $role
+	 */
 	function current_user_can( $role ) {
 		return current_user_can( $role );
 	}

_inc/lib/class.core-rest-api-endpoints.php

Doc Comments -1 removed lines

@@ -1264,7 +1264,6 @@
 	 *
 	 * @since 4.3.0
 	 *
-	 * @param WP_REST_Request $request The request sent to the WP REST API.
 	 *
 	 * @return object
 	 */

3rd-party/class-jetpack-bbpress-rest-api.php

Doc Comments +2 added lines, -2 removed lines

@@ -45,7 +45,7 @@ 
 	 *
 	 * @param array $allowed_post_types Allowed post types.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function allow_bbpress_post_types( $allowed_post_types ) {
 		$allowed_post_types[] = 'forum';
@@ -59,7 +59,7 @@ 
 	 *
 	 * @param array $allowed_meta_keys Allowed meta keys.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function allow_bbpress_public_metadata( $allowed_meta_keys ) {
 		$allowed_meta_keys[] = '_bbp_forum_id';

_inc/lib/class.jetpack-password-checker.php

Doc Comments +1 added lines, -1 removed lines

@@ -410,7 +410,7 @@
 	 *
 	 * @param Mixed $needle the needle.
 	 * @param array $haystack the haystack.
-	 * @return is the needle not in the haystack?
+	 * @return boolean the needle not in the haystack?
 	 */
 	protected function negative_in_array( $needle, $haystack ) {
 		if ( in_array( $needle, $haystack, true ) ) {

class.json-api.php

Doc Comments +15 added lines, -1 removed lines

@@ -348,6 +348,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;
@@ -571,11 +574,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'];
 	}
@@ -598,6 +608,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.
@@ -647,7 +661,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 ) {

modules/scan/class-admin-bar-notice.php

Doc Comments +1 added lines, -1 removed lines

@@ -143,7 +143,7 @@
 	/**
 	 *
 	 * Return Whether boolean cached threats exist or null if the state is unknown.
-	 * * @return boolean or null
+	 * * @return null|boolean or null
 	 */
 	public function has_threats() {
 		$scan_state = get_transient( 'jetpack_scan_state' );

modules/gravatar-hovercards.php

Doc Comments +1 added lines, -1 removed lines

@@ -154,7 +154,7 @@
  * @param string $avatar The <img/> element of the avatar.
  * @param mixed $author User ID, email address, user login, comment object, user object, post object
  *
- * @return The <img/> element of the avatar.
+ * @return string <img/> element of the avatar.
  */
 function grofiles_get_avatar( $avatar, $author ) {
 	$is_amp = class_exists( 'Jetpack_AMP_Support' ) && Jetpack_AMP_Support::is_amp_request();

modules/woocommerce-analytics/classes/class-jetpack-woocommerce-analytics-universal.php

Doc Comments +1 added lines, -1 removed lines

@@ -310,7 +310,7 @@
 	/**
 	 * Get the current user id
 	 *
-	 * @return int
+	 * @return string
 	 */
 	public function get_user_id() {
 		if ( is_user_logged_in() ) {