Automattic / jetpack

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',

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.photon.php

Doc Comments +1 added lines, -1 removed lines

@@ -1095,7 +1095,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;

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

Doc Comments +44 added lines, -2 removed lines

@@ -283,6 +283,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'] ) ) {
@@ -1878,7 +1881,6 @@ 
 	 *
 	 * @see ::style()
 	 * @internal
-	 * @param bool $style
 	 */
 	static function _style_on() {
 		return self::style( true );
@@ -2023,6 +2025,7 @@ 
 	 *
 	 * @param int                         $feedback_id
 	 * @param object Grunion_Contact_Form $form
+	 * @param Grunion_Contact_Form $form
 	 *
 	 * @return string $message
 	 */
@@ -2135,7 +2138,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
@@ -3158,6 +3161,9 @@ 
 
 	}
 
+	/**
+	 * @param string $type
+	 */
 	function render_input_field( $type, $id, $value, $class, $placeholder, $required ) {
 		return "<input 
 					type='". esc_attr( $type ) ."' 
@@ -3169,24 +3175,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
@@ -3201,6 +3223,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 ) {
@@ -3222,6 +3247,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";
@@ -3231,6 +3259,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 ) {
@@ -3246,6 +3277,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";
@@ -3263,6 +3297,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 );
@@ -3282,6 +3320,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 );

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