Automattic / jetpack

json-endpoints/class.wpcom-json-api-site-user-endpoint.php

Doc Comments +1 added lines

@@ -64,6 +64,7 @@
 	/**
 	 * Updates user data
 	 *
+	 * @param integer $user_id
 	 * @return (array)
 	 */
 	public function update_user( $user_id, $blog_id ) {

modules/custom-post-types/portfolios.php

Doc Comments +5 added lines, -4 removed lines

@@ -488,7 +488,7 @@ 
 	 * Our [portfolio] shortcode.
 	 * Prints Portfolio data styled to look good on *any* theme.
 	 *
-	 * @return portfolio_shortcode_html
+	 * @return string
 	 */
 	static function portfolio_shortcode( $atts ) {
 		// Default attributes
@@ -621,7 +621,7 @@ 
 	 * The Portfolio shortcode loop.
 	 *
 	 * @todo add theme color styles
-	 * @return html
+	 * @return string
 	 */
 	static function portfolio_shortcode_html( $atts ) {
 
@@ -713,6 +713,7 @@ 
 	/**
 	 * Individual project class
 	 *
+	 * @param integer $portfolio_index_number
 	 * @return string
 	 */
 	static function get_project_class( $portfolio_index_number, $columns ) {
@@ -820,7 +821,7 @@ 
 	/**
 	 * Displays the author of the current portfolio project.
 	 *
-	 * @return html
+	 * @return string
 	 */
 	static function get_project_author() {
 		$html = '<div class="project-author">';
@@ -837,7 +838,7 @@ 
 	/**
 	 * Display the featured image if it's available
 	 *
-	 * @return html
+	 * @return string|null
 	 */
 	static function get_portfolio_thumbnail_link( $post_id ) {
 		if ( has_post_thumbnail( $post_id ) ) {

modules/custom-post-types/testimonial.php

Doc Comments +4 added lines, -3 removed lines

@@ -525,7 +525,7 @@ 
 	 * Our [testimonial] shortcode.
 	 * Prints Testimonial data styled to look good on *any* theme.
 	 *
-	 * @return jetpack_testimonial_shortcode_html
+	 * @return string
 	 */
 	static function jetpack_testimonial_shortcode( $atts ) {
 		// Default attributes
@@ -588,7 +588,7 @@ 
 	/**
 	 * The Testimonial shortcode loop.
 	 *
-	 * @return html
+	 * @return string
 	 */
 	static function jetpack_testimonial_shortcode_html( $atts ) {
 		// Default query arguments
@@ -662,6 +662,7 @@ 
 	/**
 	 * Individual testimonial class
 	 *
+	 * @param integer $testimonial_index_number
 	 * @return string
 	 */
 	static function get_testimonial_class( $testimonial_index_number, $columns, $image ) {
@@ -708,7 +709,7 @@ 
 	/**
 	 * Display the featured image if it's available
 	 *
-	 * @return html
+	 * @return string|null
 	 */
 	static function get_testimonial_thumbnail_link( $post_id ) {
 		if ( has_post_thumbnail( $post_id ) ) {

modules/sso/class.jetpack-sso-helpers.php

Doc Comments +1 added lines, -1 removed lines

@@ -179,7 +179,7 @@
 	 * @param array $hosts
 	 * @param string $api_base
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	static function allowed_redirect_hosts( $hosts, $api_base = JETPACK__API_BASE ) {
 		if ( empty( $hosts ) ) {

class.jetpack-options.php

Doc Comments +6 added lines

@@ -141,6 +141,9 @@ 
 		return $value;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	private static function update_grouped_option( $group, $name, $value ) {
 		$options = get_option( self::$grouped_options[ $group ] );
 		if ( ! is_array( $options ) ) {
@@ -232,6 +235,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	private static function get_grouped_option( $group, $name, $default ) {
 		$options = get_option( self::$grouped_options[ $group ] );
 		if ( is_array( $options ) && isset( $options[ $name ] ) ) {

sync/class.jetpack-sync-listener.php

Doc Comments +3 added lines

@@ -162,6 +162,9 @@
 		$queue->add_all( $data_to_enqueue );
 	}
 
+	/**
+	 * @param Jetpack_Sync_Queue $queue
+	 */
 	function enqueue_action( $current_filter, $args, $queue ) {
 		/**
 		 * Modify or reject the data within an action before it is enqueued locally.

sync/class.jetpack-sync-module-full-sync.php

Doc Comments +6 added lines

@@ -234,6 +234,9 @@ 
 		$listener->get_full_sync_queue()->reset();
 	}
 
+	/**
+	 * @param integer $default
+	 */
 	private function get_status_option( $option, $default = null ) {
 		$prefix = self::STATUS_OPTION_PREFIX;
 
@@ -270,6 +273,9 @@ 
 		$this->queue_items_added( 1 );
 	}
 
+	/**
+	 * @param integer $item_count
+	 */
 	public function queue_items_added( $item_count ) {
 		// jpsq_item_added and jpsq_items_added both exec 1 db query, 
 		// so we ignore $item_count and treat it as always 1

sync/class.jetpack-sync-modules.php

Doc Comments +3 added lines

@@ -58,6 +58,9 @@
 		}
 	}
 
+	/**
+	 * @param string $module_name
+	 */
 	public static function get_module( $module_name ) {
 		foreach ( self::get_modules() as $module ) {
 			if ( $module->name() === $module_name ) {

sync/class.jetpack-sync-queue.php

Doc Comments +9 added lines

@@ -7,6 +7,9 @@ 
 	public $id;
 	public $items_with_ids;
 
+	/**
+	 * @param string $id
+	 */
 	public function __construct( $id, $items_with_ids ) {
 		$this->id             = $id;
 		$this->items_with_ids = $items_with_ids;
@@ -35,6 +38,9 @@ 
 	public $id;
 	private $row_iterator;
 
+	/**
+	 * @param string $id
+	 */
 	function __construct( $id ) {
 		$this->id           = str_replace( '-', '_', $id ); // necessary to ensure we don't have ID collisions in the SQL
 		$this->row_iterator = 0;
@@ -312,6 +318,9 @@ 
 		return get_transient( $this->get_checkout_transient_name() );
 	}
 
+	/**
+	 * @param string $checkout_id
+	 */
 	private function set_checkout_id( $checkout_id ) {
 		return set_transient( $this->get_checkout_transient_name(), $checkout_id, 5 * 60 ); // 5 minute timeout
 	}