Automattic / jetpack

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() ) {

modules/subscriptions.php

Doc Comments +1 added lines, -1 removed lines

@@ -514,7 +514,7 @@
 	 * Send a synchronous XML-RPC subscribe to blog posts or subscribe to post comments request.
 	 *
 	 * @param string $email
-	 * @param array  $post_ids (optional) defaults to 0 for blog posts only: array of post IDs to subscribe to blog's posts
+	 * @param integer  $post_ids (optional) defaults to 0 for blog posts only: array of post IDs to subscribe to blog's posts
 	 * @param bool   $async    (optional) Should the subscription be performed asynchronously?  Defaults to true.
 	 *
 	 * @return true|WP_Error true on success

modules/wordads/class-wordads.php

Doc Comments +2 added lines, -2 removed lines

@@ -118,7 +118,7 @@ 
 	 * Convenience function for grabbing options from params->options
 	 *
 	 * @param  string $option the option to grab.
-	 * @param  mixed  $default (optional).
+	 * @param  boolean  $default (optional).
 	 * @return option or $default if not set
 	 *
 	 * @since 4.5.0
@@ -710,7 +710,7 @@ 
 	/**
 	 * Check the reasons to bail before we attempt to insert ads.
 	 *
-	 * @return true if we should bail (don't insert ads)
+	 * @return boolean if we should bail (don't insert ads)
 	 *
 	 * @since 4.5.0
 	 */

modules/wordads/php/class-wordads-sidebar-widget.php

Doc Comments +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
 	 * @param array $args Widget args.
 	 * @param array $instance The Widget instance.
 	 *
-	 * @return bool|void
+	 * @return false|null
 	 */
 	public function widget( $args, $instance ) {
 		global $wordads;

json-endpoints/class.wpcom-json-api-list-posts-v1-1-endpoint.php

Doc Comments +3 added lines

@@ -433,6 +433,9 @@
 		);
 	}
 
+	/**
+	 * @param string $column
+	 */
 	function _build_date_range_query( $column, $range, $where ) {
 		global $wpdb;
 

_inc/lib/core-api/load-wpcom-endpoints.php

Doc Comments +3 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 );