Automattic / jetpack

modules/widgets/goodreads.php

Doc Comments +3 added lines

@@ -90,6 +90,9 @@
 		echo $args['after_widget'];
 	}
 
+	/**
+	 * @param string $user_id
+	 */
 	function goodreads_user_id_exists( $user_id ) {
 		$url = "http://www.goodreads.com/user/show/$user_id/";
 		$response = wp_remote_head( $url, array( 'httpversion'=>'1.1', 'timeout'=>3, 'redirection'=> 2 ) );

sync/class.jetpack-sync-listener.php

Doc Comments +3 added lines

@@ -164,6 +164,9 @@
 		$queue->add_all( $data_to_enqueue );
 	}
 
+	/**
+	 * @param Jetpack_Sync_Queue $queue
+	 */
 	function enqueue_action( $current_filter, $args, $queue ) {
 		// don't enqueue an action during the outbound http request - this prevents recursion
 		if ( Jetpack_Sync_Settings::is_sending() ) {

sync/class.jetpack-sync-queue.php

Doc Comments +6 added lines

@@ -246,6 +246,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param Jetpack_Sync_Queue_Buffer $buffer
+	 */
 	function close( $buffer, $ids_to_remove = null ) {
 		$is_valid = $this->validate_checkout( $buffer );
 
@@ -339,6 +342,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $checkout_id
+	 */
 	private function set_checkout_id( $checkout_id ) {
 		global $wpdb;
 

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 behaviour
 		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/post-by-email.php

Doc Comments +1 added lines, -1 removed lines

@@ -175,7 +175,7 @@
 	/**
 	 * Back end function to abstract the xmlrpc function calls to wpcom.
 	 *
-	 * @param $endpoint
+	 * @param string $endpoint
 	 * @param $error_message
 	 */
 	function __process_ajax_proxy_request( $endpoint, $error_message ) {

modules/related-posts/jetpack-related-posts.php

Doc Comments +5 added lines

@@ -294,6 +294,9 @@ 
 		return $this->_options;
 	}
 	
+	/**
+	 * @param string $option_name
+	 */
 	public function get_option( $option_name ) {
 		$options = $this->get_options();
 		
@@ -1428,6 +1431,8 @@ 
 	 * Enqueues assets needed to do async loading of related posts.
 	 *
 	 * @uses wp_enqueue_script, wp_enqueue_style, plugins_url
+	 * @param boolean $script
+	 * @param boolean $style
 	 * @return null
 	 */
 	protected function _enqueue_assets( $script, $style ) {

modules/stats.php

Doc Comments +2 added lines, -2 removed lines

@@ -246,7 +246,7 @@ 
  * Get Stats Options.
  *
  * @access public
- * @param mixed $option Option.
+ * @param string $option Option.
  * @return mixed|null.
  */
 function stats_get_option( $option ) {
@@ -651,7 +651,7 @@ 
  * Stats Convert Chart URLs.
  *
  * @access public
- * @param mixed $html HTML.
+ * @param string $html HTML.
  * @return string
  */
 function stats_convert_chart_urls( $html ) {

_inc/lib/class.media.php

Doc Comments +6 added lines, -3 removed lines

@@ -87,7 +87,7 @@ 
 	/**
 	 * Return an array of allowed mime_type items used to upload a media file.
 	 * 	
-	 * @return array mime_type array
+	 * @return string[] mime_type array
 	 */
 	static function get_allowed_mime_types( $default_mime_types ) {
 		return array_unique( array_merge( $default_mime_types, array(
@@ -254,7 +254,7 @@ 
 	 * @param  object $media_item - media post object
 	 * @param  file $file - file recently added
 	 * @param  bool $has_original_media - condition is the original media has been already added
-	 * @return bool `true` if the item has been added. Otherwise `false`.
+	 * @return false|null `true` if the item has been added. Otherwise `false`.
 	 */
 	public static function register_revision( $media_item, $file, $has_original_media ) {
 		if ( is_wp_error( $file ) || ! $has_original_media ) {
@@ -282,6 +282,9 @@ 
 		return $original;
 	}
 
+	/**
+	 * @param string $pathname
+	 */
 	public static function delete_file( $pathname ) {
 		if ( ! file_exists( $pathname ) || ! is_file( $pathname ) ) {
 			// let's touch a fake file to try to `really` remove the media file
@@ -297,7 +300,7 @@ 
 	 * 
 	 * @param  number $media_id - media post ID
 	 * @param  string $filename - basename of the file ( name-of-file.ext )
-	 * @return bool `true` is the file has been removed, `false` if not.
+	 * @return boolean|null `true` is the file has been removed, `false` if not.
 	 */
 	private static function delete_media_history_file( $media_id, $filename ) {
 		$attached_path = get_attached_file( $media_id );

json-endpoints/class.wpcom-json-api-edit-media-v1-2-endpoint.php

Doc Comments +2 added lines, -2 removed lines

@@ -7,7 +7,7 @@ 
 	 * Update the media post grabbing the post values from
 	 * the `attrs` parameter
 	 *
-	 * @param  {Number} $media_id - post media ID
+	 * @param  integer $media_id - post media ID
 	 * @param  {Object} $attrs - `attrs` parameter sent from the client in the request body
 	 * @return bool|WP_Error `WP_Error` on failure. `true` on success.
 	 */
@@ -64,7 +64,7 @@ 
 	/**
 	 * Get the image from a remote url and then save it locally.
 	 *
-	 * @param  {Number} $media_id - media post ID
+	 * @param  integer $media_id - media post ID
 	 * @param  {String} $url - image URL to save locally
 	 * @return {Array|WP_Error} An array with information about the new file saved or a WP_Error is something went wrong.
 	 */