Automattic / jetpack

projects/plugins/jetpack/json-endpoints/class.wpcom-json-api-update-term-endpoint.php

Doc Comments +17 added lines

@@ -115,6 +115,11 @@ 
 	}
 
 	// /sites/%s/taxonomies/%s/terms/new -> $blog_id, $taxonomy
+
+	/**
+	 * @param string $path
+	 * @param string $taxonomy
+	 */
 	function new_term( $path, $blog_id, $taxonomy ) {
 		$args = $this->query_args();
 		$input = $this->input();
@@ -160,6 +165,12 @@ 
 	}
 
 	// /sites/%s/taxonomies/%s/terms/slug:%s -> $blog_id, $taxonomy, $slug
+
+	/**
+	 * @param string $path
+	 * @param string $slug
+	 * @param string $taxonomy
+	 */
 	function update_term( $path, $blog_id, $slug, $taxonomy ) {
 		$tax = get_taxonomy( $taxonomy );
 		if ( ! current_user_can( $tax->cap->edit_terms ) ) {
@@ -208,6 +219,12 @@ 
 	}
 
 	// /sites/%s/taxonomies/%s/terms/slug:%s/delete -> $blog_id, $taxonomy, $slug
+
+	/**
+	 * @param string $path
+	 * @param string $slug
+	 * @param string $taxonomy
+	 */
 	function delete_term( $path, $blog_id, $slug, $taxonomy ) {
 		$term = get_term_by( 'slug', $slug, $taxonomy );
 		$tax = get_taxonomy( $taxonomy );

projects/plugins/jetpack/json-endpoints/jetpack/class.jetpack-json-api-cron-endpoint.php

Doc Comments +6 added lines

@@ -24,6 +24,9 @@ 
 		return  isset( $args['arguments'] ) ? json_decode( $args['arguments'] ) : array();
 	}
 
+	/**
+	 * @param double $gmt_time
+	 */
 	protected function is_cron_locked( $gmt_time ) {
 		// The cron lock: a unix timestamp from when the cron was spawned.
 		$doing_cron_transient = $this->get_cron_lock();
@@ -33,6 +36,9 @@ 
 		return $doing_cron_transient;
 	}
 
+	/**
+	 * @param string $doing_wp_cron
+	 */
 	protected function maybe_unlock_cron( $doing_wp_cron ) {
 		if ( $this->get_cron_lock() == $doing_wp_cron ) {
 			delete_transient( 'doing_cron' );

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

Doc Comments +3 added lines

@@ -170,6 +170,9 @@
 	}
 
 
+	/**
+	 * @param string $plugin
+	 */
 	protected function validate_plugin( $plugin ) {
 		if ( ! isset( $plugin) || empty( $plugin ) ) {
 			return new WP_Error( 'missing_plugin', __( 'You are required to specify a plugin to activate.', 'jetpack' ), 400 );

projects/plugins/jetpack/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 );

projects/plugins/jetpack/json-endpoints/jetpack/class.jetpack-json-api-sync-endpoint.php

Doc Comments +3 added lines

@@ -228,6 +228,9 @@
 		);
 	}
 
+	/**
+	 * @param Queue $queue
+	 */
 	protected function get_buffer( $queue, $number_of_items ) {
 		$start = time();
 		$max_duration = 5; // this will try to get the buffer

projects/packages/sync/src/interface-replicastore.php

Doc Comments +30 added lines

@@ -20,6 +20,7 @@ 
 	 * Empty and reset the replicastore.
 	 *
 	 * @access public
+	 * @return void
 	 */
 	public function reset();
 
@@ -29,6 +30,7 @@ 
 	 * @access public
 	 *
 	 * @param array $config Full sync configuration for this sync module.
+	 * @return void
 	 */
 	public function full_sync_start( $config );
 
@@ -38,6 +40,7 @@ 
 	 * @access public
 	 *
 	 * @param string $checksum Deprecated since 7.3.0.
+	 * @return void
 	 */
 	public function full_sync_end( $checksum );
 
@@ -51,6 +54,7 @@ 
 	 * @param string $status Post status.
 	 * @param int    $min_id Minimum post ID.
 	 * @param int    $max_id Maximum post ID.
+	 * @return integer
 	 */
 	public function post_count( $status = null, $min_id = null, $max_id = null );
 
@@ -81,6 +85,7 @@ 
 	 *
 	 * @param \WP_Post $post   Post object.
 	 * @param bool     $silent Whether to perform a silent action.
+	 * @return void
 	 */
 	public function upsert_post( $post, $silent = false );
 
@@ -90,6 +95,7 @@ 
 	 * @access public
 	 *
 	 * @param int $post_id Post ID.
+	 * @return void
 	 */
 	public function delete_post( $post_id );
 
@@ -121,6 +127,7 @@ 
 	 * @param string $status Comment status.
 	 * @param int    $min_id Minimum comment ID.
 	 * @param int    $max_id Maximum comment ID.
+	 * @return integer
 	 */
 	public function comment_count( $status = null, $min_id = null, $max_id = null );
 
@@ -150,6 +157,7 @@ 
 	 * @access public
 	 *
 	 * @param \WP_Comment $comment Comment object.
+	 * @return void
 	 */
 	public function upsert_comment( $comment );
 
@@ -159,6 +167,7 @@ 
 	 * @access public
 	 *
 	 * @param int $comment_id Comment ID.
+	 * @return void
 	 */
 	public function trash_comment( $comment_id );
 
@@ -168,6 +177,7 @@ 
 	 * @access public
 	 *
 	 * @param int $comment_id Comment ID.
+	 * @return void
 	 */
 	public function spam_comment( $comment_id );
 
@@ -177,6 +187,7 @@ 
 	 * @access public
 	 *
 	 * @param int $comment_id Comment ID.
+	 * @return void
 	 */
 	public function delete_comment( $comment_id );
 
@@ -187,6 +198,7 @@ 
 	 *
 	 * @param int   $post_id  Post ID.
 	 * @param array $statuses Post statuses.
+	 * @return void
 	 */
 	public function trashed_post_comments( $post_id, $statuses );
 
@@ -196,6 +208,7 @@ 
 	 * @access public
 	 *
 	 * @param int $post_id Post ID.
+	 * @return void
 	 */
 	public function untrashed_post_comments( $post_id );
 
@@ -226,6 +239,7 @@ 
 	 *
 	 * @param string $option Option name.
 	 * @param mixed  $value  Option value.
+	 * @return boolean|null
 	 */
 	public function update_option( $option, $value );
 
@@ -245,6 +259,7 @@ 
 	 * @access public
 	 *
 	 * @param string $option Name of option to remove.
+	 * @return boolean|null
 	 */
 	public function delete_option( $option );
 
@@ -254,6 +269,7 @@ 
 	 * @access public
 	 *
 	 * @param array $theme_info Theme info array.
+	 * @return void
 	 */
 	public function set_theme_info( $theme_info );
 
@@ -288,6 +304,7 @@ 
 	 * @param string $meta_key   Meta key.
 	 * @param mixed  $meta_value Meta value.
 	 * @param int    $meta_id    ID of the meta.
+	 * @return boolean|null
 	 */
 	public function upsert_metadata( $type, $object_id, $meta_key, $meta_value, $meta_id );
 
@@ -299,6 +316,7 @@ 
 	 * @param string $type      Meta type.
 	 * @param int    $object_id ID of the object.
 	 * @param array  $meta_ids  IDs of the meta objects to delete.
+	 * @return false|null
 	 */
 	public function delete_metadata( $type, $object_id, $meta_ids );
 
@@ -310,6 +328,7 @@ 
 	 * @param string $type       Meta type.
 	 * @param array  $object_ids IDs of the objects.
 	 * @param string $meta_key   Meta key.
+	 * @return false|null
 	 */
 	public function delete_batch_metadata( $type, $object_ids, $meta_key );
 
@@ -350,6 +369,7 @@ 
 	 *
 	 * @param string $type    Type of updates to set.
 	 * @param int    $updates Total number of updates.
+	 * @return void
 	 */
 	public function set_updates( $type, $updates );
 
@@ -369,6 +389,7 @@ 
 	 *
 	 * @param string $callable Callable name.
 	 * @param mixed  $value    Callable value.
+	 * @return void
 	 */
 	public function set_callable( $callable, $value );
 
@@ -388,6 +409,7 @@ 
 	 *
 	 * @param string $option Network option name.
 	 * @param mixed  $value  Network option value.
+	 * @return boolean|null
 	 */
 	public function update_site_option( $option, $value );
 
@@ -397,6 +419,7 @@ 
 	 * @access public
 	 *
 	 * @param string $option Name of option to remove.
+	 * @return boolean|null
 	 */
 	public function delete_site_option( $option );
 
@@ -458,6 +481,7 @@ 
 	 * @param string           $taxonomy  The context in which to relate the term to the object.
 	 * @param string|int|array $terms     A single term slug, single term id, or array of either term slugs or ids.
 	 * @param bool             $append    Optional. If false will delete difference of terms. Default false.
+	 * @return void
 	 */
 	public function update_object_terms( $object_id, $taxonomy, $terms, $append );
 
@@ -470,6 +494,7 @@ 
 	 *
 	 * @param int   $object_id ID of the object.
 	 * @param array $tt_ids    Term taxonomy IDs.
+	 * @return boolean|null
 	 */
 	public function delete_object_terms( $object_id, $tt_ids );
 
@@ -477,6 +502,7 @@ 
 	 * Retrieve the number of users.
 	 *
 	 * @access public
+	 * @return null|integer
 	 */
 	public function user_count();
 
@@ -495,6 +521,7 @@ 
 	 * @access public
 	 *
 	 * @param \WP_User $user User object.
+	 * @return void
 	 */
 	public function upsert_user( $user );
 
@@ -504,6 +531,7 @@ 
 	 * @access public
 	 *
 	 * @param int $user_id User ID.
+	 * @return void
 	 */
 	public function delete_user( $user_id );
 
@@ -514,6 +542,7 @@ 
 	 *
 	 * @param int    $user_id User ID.
 	 * @param string $locale  The user locale.
+	 * @return void
 	 */
 	public function upsert_user_locale( $user_id, $locale );
 
@@ -523,6 +552,7 @@ 
 	 * @access public
 	 *
 	 * @param int $user_id User ID.
+	 * @return void
 	 */
 	public function delete_user_locale( $user_id );
 

projects/packages/sync/src/modules/class-module.php

Doc Comments +5 added lines, -5 removed lines

@@ -67,7 +67,7 @@ 
 	 *
 	 * @param string $object_type Type of the sync object.
 	 * @param int    $id          ID of the sync object.
-	 * @return mixed Object, or false if the object is invalid.
+	 * @return boolean Object, or false if the object is invalid.
 	 */
 	public function get_object_by_id( $object_type, $id ) {
 		return false;
@@ -124,7 +124,7 @@ 
 	 *
 	 * @access public
 	 *
-	 * @param array   $config               Full sync configuration for this sync module.
+	 * @param boolean   $config               Full sync configuration for this sync module.
 	 * @param int     $max_items_to_enqueue Maximum number of items to enqueue.
 	 * @param boolean $state                True if full sync has finished enqueueing this module, false otherwise.
 	 * @return array  Number of actions enqueued, and next module state.
@@ -166,8 +166,8 @@ 
 	 * @access protected
 	 *
 	 * @param array $action_names     Action names we're interested in.
-	 * @param array $actions_to_count Unfiltered list of actions we want to count.
-	 * @return array Number of actions that we're interested in.
+	 * @param string[] $actions_to_count Unfiltered list of actions we want to count.
+	 * @return integer Number of actions that we're interested in.
 	 */
 	protected function count_actions( $action_names, $actions_to_count ) {
 		return count( array_intersect( $action_names, $actions_to_count ) );
@@ -285,7 +285,7 @@ 
 	/**
 	 * Given the Module Full Sync Configuration and Status return the next chunk of items to send.
 	 *
-	 * @param array $config This module Full Sync configuration.
+	 * @param string $config This module Full Sync configuration.
 	 * @param array $status This module Full Sync status.
 	 * @param int   $chunk_size Chunk size.
 	 *

projects/plugins/jetpack/_inc/lib/core-api/class-wpcom-rest-field-controller.php

Doc Comments +2 added lines, -2 removed lines

@@ -109,9 +109,9 @@
 	 *
 	 * This cannot be extended: implement `->get()` instead.
 	 *
-	 * @param mixed           $object_data Probably an array. Whatever the endpoint returns.
+	 * @param integer           $object_data Probably an array. Whatever the endpoint returns.
 	 * @param string          $field_name Should always match `->field_name`
-	 * @param WP_REST_Request $request
+	 * @param integer $request
 	 * @param string          $object_type Should always match `->object_type`
 	 * @return mixed
 	 */

projects/plugins/jetpack/_inc/lib/core-api/load-wpcom-endpoints.php

Doc Comments +6 added lines

@@ -15,6 +15,9 @@ 
 	exit;
 }
 
+/**
+ * @param string $file_pattern
+ */
 function wpcom_rest_api_v2_load_plugin_files( $file_pattern ) {
 	$plugins = glob( dirname( __FILE__ ) . '/' . $file_pattern );
 
@@ -28,6 +31,9 @@ 
 }
 
 // API v2 plugins: define a class, then call this function.
+/**
+ * @param string $class_name
+ */
 function wpcom_rest_api_v2_load_plugin( $class_name ) {
 	global $wpcom_rest_api_v2_plugins;