Automattic / jetpack

modules/sharedaddy/sharing-sources.php

Doc Comments +9 added lines

@@ -42,6 +42,9 @@ 
 		return $this->id;
 	}
 
+	/**
+	 * @return string
+	 */
 	public function get_share_url( $post_id ) {
 		/**
 		 * Filter the sharing permalink.
@@ -324,6 +327,9 @@ 
 		do_action( 'sharing_bump_stats', array( 'service' => $this, 'post' => $post ) );
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function js_dialog( $name, $params = array() ) {
 		if ( true !== $this->open_link_in_new ) {
 			return;
@@ -1463,6 +1469,9 @@ 
 		return __( 'Pinterest', 'jetpack' );
 	}
 
+	/**
+	 * @return string
+	 */
 	public function get_image( $post ) {
 		if ( class_exists( 'Jetpack_PostImages' ) ) {
 			$image = Jetpack_PostImages::get_image( $post->ID, array( 'fallback_to_avatars' => true ) );

_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

sync/class.jetpack-sync-settings.php

Doc Comments +9 added lines

@@ -135,6 +135,9 @@ 
 		self::set_is_sending( null );
 	}
 
+	/**
+	 * @param boolean|null $is_importing
+	 */
 	static function set_importing( $is_importing ) {
 		// set to NULL to revert to WP_IMPORTING, the standard behavior
 		self::$is_importing = $is_importing;
@@ -165,6 +168,9 @@ 
 		return (bool) self::$is_syncing || ( defined( 'REST_API_REQUEST' ) && REST_API_REQUEST );
 	}
 
+	/**
+	 * @param boolean|null $is_syncing
+	 */
 	static function set_is_syncing( $is_syncing ) {
 		self::$is_syncing = $is_syncing;
 	}
@@ -173,6 +179,9 @@ 
 		return (bool) self::$is_sending;
 	}
 
+	/**
+	 * @param boolean|null $is_sending
+	 */
 	static function set_is_sending( $is_sending ) {
 		self::$is_sending = $is_sending;
 	}

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 +4 added lines, -1 removed lines

@@ -441,7 +441,7 @@ 
 	 *
 	 * @param array $connections_data
 	 *
-	 * @return array {
+	 * @return string {
 	 *     Array of content for generating connection form.
 	 *
 	 *     @type string HTML content of form
@@ -544,6 +544,9 @@ 
 		return ob_get_clean();
 	}
 
+	/**
+	 * @return string
+	 */
 	private function google_plus_shut_down_notice() {
 		return wp_kses(
 			sprintf(

_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' );

sync/class.jetpack-sync-actions.php

Doc Comments +6 added lines

@@ -321,6 +321,9 @@ 
 		return $sync_modules;
 	}
 
+	/**
+	 * @return string
+	 */
 	static function sanitize_filtered_sync_cron_schedule( $schedule ) {
 		$schedule  = sanitize_key( $schedule );
 		$schedules = wp_get_schedules();
@@ -358,6 +361,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $hook
+	 */
 	static function maybe_schedule_sync_cron( $schedule, $hook ) {
 		if ( ! $hook ) {
 			return;

sync/class.jetpack-sync-sender.php

Doc Comments +10 added lines

@@ -76,6 +76,9 @@ 
 		return (float) get_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name, 0 );
 	}
 
+	/**
+	 * @param integer $time
+	 */
 	public function set_next_sync_time( $time, $queue_name ) {
 		return update_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name, $time, true );
 	}
@@ -106,6 +109,9 @@ 
 		return $this->do_sync_and_set_delays( $this->sync_queue );
 	}
 
+	/**
+	 * @param Jetpack_Sync_Queue $queue
+	 */
 	public function do_sync_and_set_delays( $queue ) {
 		// don't sync if importing
 		if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) {
@@ -354,6 +360,10 @@ 
 	}
 
 	// in seconds
+
+	/**
+	 * @param double $seconds
+	 */
 	function set_max_dequeue_time( $seconds ) {
 		$this->max_dequeue_time = $seconds;
 	}