Automattic / jetpack

sal/class.json-api-site-jetpack-base.php

Doc Comments +15 added lines

@@ -4,12 +4,27 @@
 require_once dirname( __FILE__ ) . '/class.json-api-site-base.php';
 
 abstract class Abstract_Jetpack_Site extends SAL_Site {
+
+	/**
+	 * @param string $name
+	 */
 	abstract protected function get_constant( $name );
 
+	/**
+	 * @param string $feature_name
+	 */
 	abstract protected function current_theme_supports( $feature_name );
 
+	/**
+	 * @param string $feature_name
+	 */
 	abstract protected function get_theme_support( $feature_name );
 
+	/**
+	 * @param string $name
+	 *
+	 * @return string
+	 */
 	abstract protected function get_mock_option( $name );
 
 	abstract protected function get_jetpack_version();

sal/class.json-api-post-base.php

Doc Comments +7 added lines

@@ -16,6 +16,9 @@ 
 	public $context;
 	public $site;
 
+	/**
+	 * @param Jetpack_Site $site
+	 */
 	function __construct( $site, $post, $context ) {
 		$this->post = $post;
 		$this->context = $context;
@@ -487,6 +490,10 @@ 
 		return $suggestions;
 	}
 
+	/**
+	 * @param string $taxonomy_type
+	 * @param string $context
+	 */
 	private function format_taxonomy( $taxonomy, $taxonomy_type, $context ) {
 		// Permissions
 		switch ( $context ) {

sal/class.json-api-links.php

Doc Comments +1 added lines, -2 removed lines

@@ -26,7 +26,6 @@ 
 	 *
 	 * Used to construct meta links in API responses
 	 *
-	 * @param mixed $args Optional arguments to be appended to URL
 	 * @return string Endpoint URL
 	 **/
 	function get_link() {
@@ -117,7 +116,7 @@ 
 	 * This method is used in get_link() to construct meta links for API responses.
 	 * 
 	 * @param $template_path The generic endpoint path, e.g. /sites/%s
-	 * @param $path string The current endpoint path, relative to the version, e.g. /sites/12345
+	 * @param string $path string The current endpoint path, relative to the version, e.g. /sites/12345
 	 * @param $method string Request method used to access the endpoint path
 	 * @return string The current version, or otherwise the maximum version available
 	 */

class.json-api-endpoints.php

Doc Comments +5 added lines

@@ -1341,6 +1341,7 @@ 
 	 * timezone set in the options table for the blog or the GMT offset.
 	 *
 	 * @param datetime string
+	 * @param string $date_string
 	 *
 	 * @return array( $local_time_string, $gmt_time_string )
 	 */
@@ -1458,6 +1459,10 @@ 
 		do_action( 'restapi_theme_init' );
 	}
 
+	/**
+	 * @param string $from_hook
+	 * @param string $to_hook
+	 */
 	function copy_hooks( $from_hook, $to_hook, $base_paths ) {
 		global $wp_filter;
 		foreach ( $wp_filter as $hook => $actions ) {

sal/class.json-api-site-base.php

Doc Comments +3 added lines

@@ -23,6 +23,9 @@
 	public $blog_id;
 	public $platform;
 
+	/**
+	 * @param WPORG_Platform $platform
+	 */
 	public function __construct( $blog_id, $platform ) {
 		$this->blog_id = $blog_id;
 		$this->platform = $platform;

json-endpoints/class.wpcom-json-api-post-v1-1-endpoint.php

Doc Comments +6 added lines

@@ -120,6 +120,9 @@ 
 		return $response;
 	}
 
+	/**
+	 * @param string $field
+	 */
 	protected function get_sal_post_by( $field, $field_value, $context ) {
 		global $blog_id;
 
@@ -132,6 +135,9 @@ 
 		return $post;
 	}
 
+	/**
+	 * @param string $context
+	 */
 	private function render_response_keys( $post, $context, $keys ) {
 		foreach ( $keys as $key ) {
 			switch ( $key ) {

sync/class.jetpack-sync-full.php

Doc Comments +7 added lines

@@ -188,6 +188,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $meta_type
+	 */
 	private function get_metadata( $ids, $meta_type ) {
 		global $wpdb;
 		$table = _get_meta_table( $meta_type );
@@ -214,6 +217,10 @@ 
 		$this->set_status("updates", 100);
 	}
 	
+	/**
+	 * @param string $name
+	 * @param integer $percent
+	 */
 	private function set_status( $name, $percent, $count = 1, $total =1 ) {
 		set_transient( self::$status_transient_name.'_'.$name, 
 			array( 

sync/class.jetpack-sync-queue.php

Doc Comments +12 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;
@@ -31,6 +34,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;
@@ -227,6 +233,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param integer $num_items_to_remove
+	 */
 	function close( $buffer, $num_items_to_remove = null ) {
 		$is_valid = $this->validate_checkout( $buffer );
 
@@ -308,6 +317,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
 	}

sync/class.jetpack-sync-client.php

Doc Comments +21 added lines

@@ -195,21 +195,36 @@ 
 		$this->network_options_whitelist = $options;
 	}
 
+	/**
+	 * @param integer $size
+	 */
 	function set_send_buffer_memory_size( $size ) {
 		$this->checkout_memory_size = $size;
 	}
 
 	// in bytes
+
+	/**
+	 * @param integer $max_bytes
+	 */
 	function set_upload_max_bytes( $max_bytes ) {
 		$this->upload_max_bytes = $max_bytes;
 	}
 
 	// in rows
+
+	/**
+	 * @param integer $max_rows
+	 */
 	function set_upload_max_rows( $max_rows ) {
 		$this->upload_max_rows = $max_rows;
 	}
 
 	// in seconds
+
+	/**
+	 * @param integer $seconds
+	 */
 	function set_min_sync_wait_time( $seconds ) {
 		update_option( self::SYNC_THROTTLE_OPTION_NAME, $seconds, true );
 	}
@@ -476,6 +491,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $action_name
+	 */
 	private function buffer_includes_action( $buffer, $action_name ) {
 		foreach ( $buffer->get_items() as $item ) {
 			if ( $item[0] === $action_name ) {
@@ -505,6 +523,9 @@ 
 		return $post;
 	}
 
+	/**
+	 * @param string $when
+	 */
 	private function schedule_sync( $when ) {
 		wp_schedule_single_event( strtotime( $when ), 'jetpack_sync_actions' );
 	}