Automattic / jetpack

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 ) {

functions.photon.php

Doc Comments +2 added lines, -1 removed lines

@@ -7,6 +7,7 @@ 
  *
  * @param string $image_url URL to the publicly accessible image you want to manipulate
  * @param array|string $args An array of arguments, i.e. array( 'w' => '300', 'resize' => array( 123, 456 ) ), or in string form (w=123&h=456)
+ * @param string $scheme
  * @return string The raw final URL. You should run this through esc_url() before displaying it.
  */
 function jetpack_photon_url( $image_url, $args = array(), $scheme = null ) {
@@ -268,7 +269,7 @@ 
  *
  * @param string $url The URL to parse
  * @param integer $component Retrieve specific URL component
- * @return mixed Result of parse_url
+ * @return string|false Result of parse_url
  */
 function jetpack_photon_parse_url( $url, $component = -1 ) {
 	if ( 0 === strpos( $url, '//' ) ) {

modules/google-analytics/wp-google-analytics.php

Doc Comments +2 added lines

@@ -80,6 +80,8 @@
 
 	/**
 	 * Maybe output or return, depending on the context
+	 * @param string $val
+	 * @param boolean $maybe
 	 */
 	private function _output_or_return( $val, $maybe ) {
 		if ( $maybe ) {

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 ) {

class.json-api.php

Doc Comments +17 added lines

@@ -31,6 +31,9 @@ 
 	public $did_output = false;
 
 	/**
+	 * @param string $method
+	 * @param string $url
+	 * @param string $post_body
 	 * @return WPCOM_JSON_API instance
 	 */
 	static function init( $method = null, $url = null, $post_body = null ) {
@@ -332,6 +335,9 @@ 
 		return call_user_func_array( array( $endpoint, 'callback' ), $path_pieces );
 	}
 
+	/**
+	 * @param integer $status_code
+	 */
 	function output_early( $status_code, $response = null, $content_type = 'application/json' ) {
 		$exit = $this->exit;
 		$this->exit = false;
@@ -526,11 +532,18 @@ 
 		return json_encode( $data );
 	}
 
+	/**
+	 * @param string $needle
+	 */
 	function ends_with( $haystack, $needle ) {
 		return $needle === substr( $haystack, -strlen( $needle ) );
 	}
 
 	// Returns the site's blog_id in the WP.com ecosystem
+
+	/**
+	 * @return integer
+	 */
 	function get_blog_id_for_output() {
 		return $this->token_details['blog_id'];
 	}
@@ -553,6 +566,10 @@ 
 	}
 
 	// Returns true if the specified blog ID is a restricted blog
+
+	/**
+	 * @param integer $blog_id
+	 */
 	function is_restricted_blog( $blog_id ) {
 		/**
 		 * Filters all REST API access and return a 403 unauthorized response for all Restricted blog IDs.

_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.
 	 */