Automattic / jetpack

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

modules/contact-form/grunion-contact-form.php

Doc Comments +44 added lines, -2 removed lines

@@ -300,6 +300,9 @@ 
 		return Grunion_Contact_Form::parse( $atts, do_blocks( $content ) );
 	}
 
+	/**
+	 * @param string $type
+	 */
 	public static function block_attributes_to_shortcode_attributes( $atts, $type ) {
 		$atts['type'] = $type;
 		if ( isset( $atts['className'] ) ) {
@@ -1918,7 +1921,6 @@ 
 	 *
 	 * @see ::style()
 	 * @internal
-	 * @param bool $style
 	 */
 	static function _style_on() {
 		return self::style( true );
@@ -2086,6 +2088,7 @@ 
 	 *
 	 * @param int                         $feedback_id
 	 * @param object Grunion_Contact_Form $form
+	 * @param Grunion_Contact_Form $form
 	 *
 	 * @return string $message
 	 */
@@ -2210,7 +2213,7 @@ 
 	 *
 	 * @param array       $attributes Key => Value pairs as parsed by shortcode_parse_atts()
 	 * @param string|null $content The shortcode's inner content: [contact-field]$content[/contact-field]
-	 * @return HTML for the contact form field
+	 * @return string for the contact form field
 	 */
 	static function parse_contact_field( $attributes, $content ) {
 		// Don't try to parse contact form fields if not inside a contact form
@@ -3233,6 +3236,9 @@ 
 
 	}
 
+	/**
+	 * @param string $type
+	 */
 	function render_input_field( $type, $id, $value, $class, $placeholder, $required ) {
 		return "<input
 					type='". esc_attr( $type ) ."'
@@ -3244,24 +3250,40 @@ 
 				/>\n";
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_email_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'email', $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'email', $id, $value, $class, $placeholder, $required );
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_telephone_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'telephone', $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'tel', $id, $value, $class, $placeholder, $required );
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_url_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'url', $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'url', $id, $value, $class, $placeholder, $required );
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_textarea_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'textarea', 'contact-form-comment-' . $id, $label, $required, $required_field_text );
 		$field .= "<textarea
@@ -3276,6 +3298,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	function render_radio_field( $id, $label, $value, $class, $required, $required_field_text ) {
 		$field = $this->render_label( '', $id, $label, $required, $required_field_text );
 		foreach ( (array) $this->get_attribute( 'options' ) as $optionIndex => $option ) {
@@ -3297,6 +3322,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	function render_checkbox_field( $id, $label, $value, $class, $required, $required_field_text ) {
 		$field = "<label class='grunion-field-label checkbox" . ( $this->is_error() ? ' form-error' : '' ) . "'>";
 			$field .= "\t\t<input type='checkbox' name='" . esc_attr( $id ) . "' value='" . esc_attr__( 'Yes', 'jetpack' ) . "' " . $class . checked( (bool) $value, true, false ) . ' ' . ( $required ? "required aria-required='true'" : '' ) . "/> \n";
@@ -3306,6 +3334,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	function render_checkbox_multiple_field( $id, $label, $value, $class, $required, $required_field_text  ) {
 		$field = $this->render_label( '', $id, $label, $required, $required_field_text );
 		foreach ( (array) $this->get_attribute( 'options' ) as $optionIndex => $option ) {
@@ -3321,6 +3352,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	function render_select_field( $id, $label, $value, $class, $required, $required_field_text ) {
 		$field = $this->render_label( 'select', $id, $label, $required, $required_field_text );
 		$field  .= "\t<select name='" . esc_attr( $id ) . "' id='" . esc_attr( $id ) . "' " . $class . ( $required ? "required aria-required='true'" : '' ) . ">\n";
@@ -3338,6 +3372,10 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_date_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'date', $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'text', $id, $value, $class, $placeholder, $required );
@@ -3357,6 +3395,10 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_default_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder, $type ) {
 		$field = $this->render_label( $type, $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'text', $id, $value, $class, $placeholder, $required );

modules/publicize/ui.php

Doc Comments +1 added lines, -1 removed lines

@@ -415,7 +415,7 @@
 	 *
 	 * @param array $connections_data
 	 *
-	 * @return array {
+	 * @return string {
 	 *     Array of content for generating connection form.
 	 *
 	 *     @type string HTML content of form

class.photon.php

Doc Comments +1 added lines, -2 removed lines

@@ -213,7 +213,6 @@ 
 	/**
 	 * Inject image sizes to Jetpack REST API responses. This wraps the filter_photon_norezise_maybe_inject_sizes function.
 	 *
-	 * @param array $data          Attachment sizes data.
 	 * @param int   $attachment_id Attachment's post ID.
 	 *
 	 * @return array Attachment sizes array.
@@ -1257,7 +1256,7 @@ 
 	 * after ourselves without breaking anyone else's filters.
 	 *
 	 * @internal
-	 * @return true
+	 * @return boolean
 	 */
 	public function _override_image_downsize_in_rest_edit_context() {
 		return true;

_inc/lib/debugger/class-jetpack-cxn-tests.php

Doc Comments +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
 	/**
 	 * Helper function to look up the expected master user and return the local WP_User.
 	 *
-	 * @return WP_User Jetpack's expected master user.
+	 * @return string Jetpack's expected master user.
 	 */
 	protected function helper_retrieve_local_master_user() {
 		$master_user = Jetpack_Options::get_option( 'master_user' );

class.jetpack-post-images.php

Doc Comments +3 added lines, -3 removed lines

@@ -162,6 +162,7 @@ 
 	/**
 	 * Get attachment images for a specified post and return them. Also make sure
 	 * their dimensions are at or above a required minimum.
+	 * @param integer $post_id
 	 */
 	static function from_attachment( $post_id, $width = 200, $height = 200 ) {
 		$images = array();
@@ -224,7 +225,7 @@ 
 	 * Check if a Featured Image is set for this post, and return it in a similar
 	 * format to the other images?_from_*() methods.
 	 * @param  int $post_id The post ID to check
-	 * @return Array containing details of the Featured Image, or empty array if none.
+	 * @return integer|null containing details of the Featured Image, or empty array if none.
 	 */
 	static function from_thumbnail( $post_id, $width = 200, $height = 200 ) {
 		$images = array();
@@ -668,7 +669,6 @@ 
 	 * resized and cropped image.
 	 *
 	 * @param  string $src
-	 * @param  int    $dimension
 	 * @return string            Transformed image URL
 	 */
 	static function fit_image_url( $src, $width, $height ) {
@@ -715,7 +715,7 @@ 
 	 *
 	 * @param mixed $html_or_id The HTML string to parse for images, or a post id.
 	 *
-	 * @return array $html_info {
+	 * @return integer $html_info {
 	 * @type string $html     Post content.
 	 * @type string $post_url Post URL.
 	 * }

modules/publicize/publicize-jetpack.php

Doc Comments +3 added lines

@@ -682,6 +682,9 @@
 		$this->options_save_other( 'linkedin' );
 	}
 
+	/**
+	 * @param string $service_name
+	 */
 	function options_save_other( $service_name ) {
 		// Nonce check
 		check_admin_referer( 'save_' . $service_name . '_token_' . $_REQUEST['connection'] );

json-endpoints/jetpack/class.jetpack-json-api-plugins-modify-endpoint.php

Doc Comments +3 added lines

@@ -244,6 +244,9 @@
 		}
 	}
 
+	/**
+	 * @param string $capability
+	 */
 	protected function current_user_can( $capability, $plugin = null ) {
 		if ( $plugin ) {
 			return current_user_can( $capability, $plugin );