Automattic / jetpack

modules/theme-tools/featured-content.php

Doc Comments +1 added lines, -1 removed lines

@@ -699,7 +699,7 @@
 	 * handlers should be copied when the theme context is loaded by the REST API.
 	 *
 	 * @param array $copy_dirs Copy paths with actions to be copied
-	 * @return array Copy paths with featured content plugin
+	 * @return string[] Copy paths with featured content plugin
 	 */
 	function wpcom_rest_api_featured_content_copy_plugin_actions( $copy_dirs ) {
 		$copy_dirs[] = __FILE__;

modules/theme-tools/infinite-scroll.php

Doc Comments -1 removed lines

@@ -40,7 +40,6 @@
 /**
  * Prevent IS from being activated if theme doesn't support it
  *
- * @param bool $can_activate
  * @filter jetpack_can_activate_infinite-scroll
  * @return bool
  */

modules/theme-tools/responsive-videos.php

Doc Comments +1 added lines

@@ -29,6 +29,7 @@
 /**
  * Adds a wrapper to videos and enqueue script
  *
+ * @param string $html
  * @return string
  */
 function jetpack_responsive_videos_embed_html( $html ) {

modules/shortcodes/crowdsignal.php

Doc Comments +3 added lines

@@ -25,6 +25,9 @@
 		add_action( 'infinite_scroll_render', array( $this, 'crowdsignal_shortcode_infinite' ), 11 );
 	}
 
+	/**
+	 * @param string $survey_link
+	 */
 	private function get_async_code( array $settings, $survey_link ) {
 		$include = <<<CONTAINER
 ( function( d, c, j ) {

modules/sitemaps/sitemap-buffer.php

Doc Comments +2 added lines, -2 removed lines

@@ -154,7 +154,7 @@ 
 	 *
 	 * @since 5.3.0
 	 *
-	 * @param array $array The item to be added.
+	 * @param string $array The item to be added.
 	 *
 	 * @return bool True if the append succeeded, False if not.
 	 */
@@ -283,7 +283,7 @@ 
 	 * @param DOMElement  $parent (optional) an element to which new children should be added.
 	 * @param DOMDocument $root (optional) the parent document.
 	 *
-	 * @return string|DOMDocument The rendered XML string or an object if root element is specified.
+	 * @return null|DOMNode The rendered XML string or an object if root element is specified.
 	 */
 	protected function array_to_xml_string( $array, $parent = null, $root = null ) {
 		$return_string = false;

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

Doc Comments +8 added lines

@@ -100,6 +100,10 @@ 
 		), menu_page_url( 'sharing', false ) );
 	}
 
+	/**
+	 * @param string $service_name
+	 * @param string $for
+	 */
 	static function refresh_url( $service_name, $for ) {
 		return add_query_arg( array(
 			'action'   => 'request',
@@ -111,6 +115,10 @@ 
 		), admin_url( 'options-general.php?page=sharing' ) );
 	}
 
+	/**
+	 * @param string $service_name
+	 * @param string $id
+	 */
 	static function disconnect_url( $service_name, $id ) {
 		return add_query_arg( array(
 			'action'   => 'delete',

_inc/lib/debugger/class-jetpack-cxn-test-base.php

Doc Comments +1 added lines, -1 removed lines

@@ -129,7 +129,7 @@
 	 *
 	 * @param string $group Testing group to check status of. Optional, default all tests.
 	 *
-	 * @return true|array True if all tests pass. Array of failed tests.
+	 * @return boolean True if all tests pass. Array of failed tests.
 	 */
 	public function pass( $group = 'default' ) {
 		$results = $this->raw_results( $group );

modules/protect/math-fallback.php

Doc Comments +2 added lines, -2 removed lines

@@ -26,7 +26,7 @@ 
 		/**
 		 * Verifies that a user answered the math problem correctly while logging in.
 		 *
-		 * @return bool Returns true if the math is correct
+		 * @return boolean|null Returns true if the math is correct
 		 * @throws Error if insuffient $_POST variables are present.
 		 * @throws Error message if the math is wrong
 		 */
@@ -109,7 +109,7 @@ 
 		/**
 		 * Requires a user to solve a simple equation. Added to any WordPress login form.
 		 *
-		 * @return VOID outputs html
+		 * @return string|null outputs html
 		 */
 		static function math_form() {
 			// Check if jpp_math_pass cookie is set and it matches valid transient

class.json-api.php

Doc Comments +18 added lines, -1 removed lines

@@ -33,6 +33,9 @@ 
 	public $extra_headers = array();
 
 	/**
+	 * @param string $method
+	 * @param string $url
+	 * @param string $post_body
 	 * @return WPCOM_JSON_API instance
 	 */
 	static function init( $method = null, $url = null, $post_body = null ) {
@@ -335,6 +338,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;
@@ -543,11 +549,18 @@ 
 		return 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'];
 	}
@@ -570,6 +583,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.
@@ -619,7 +636,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 ) {