Automattic / jetpack

docker/mu-plugins/debug.php

Doc Comments +1 added lines

@@ -40,6 +40,7 @@
  * l($arg1, $arg2) will call l($arg1) and l($arg2) and then return $arg1.
  *
  * A null argument will log the file and line number of the l() call.
+ * @param string $stuff
  */
 function l( $stuff = null ) {
 	// Do nothing when debugging is off

_inc/class.jetpack-provision.php

Doc Comments +3 added lines

@@ -249,6 +249,9 @@
 		}
 	}
 
+	/**
+	 * @param string $access_token
+	 */
 	private static function verify_token( $access_token ) {
 		$request = array(
 			'headers' => array(

json-endpoints/class.wpcom-json-api-list-post-type-taxonomies-endpoint.php

Doc Comments +3 added lines

@@ -75,6 +75,9 @@
 		);
 	}
 
+	/**
+	 * @param string $post_type
+	 */
 	protected function localize_initial_taxonomies( $post_type ) {
 		/** This filter is documented in jetpack/json-endpoints/class.wpcom-json-api-list-post-types-endpoint.php */
 		if ( ! apply_filters( 'rest_api_localize_response', false ) ) {

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

Doc Comments +3 added lines, -3 removed lines

@@ -101,7 +101,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
 	 */
@@ -202,7 +202,7 @@ 
 	 * Save the given temporal file in a local folder.
 	 *
 	 * @param  {Array} $file_array
-	 * @param  {Number} $media_id
+	 * @param  integer $media_id
 	 * @return {Array|WP_Error} An array with information about the new file saved or a WP_Error is something went wrong.
 	 */
 	private function save_temporary_file( $file_array, $media_id ) {
@@ -277,7 +277,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.
 	 */

modules/memberships/class-jetpack-memberships.php

Doc Comments +1 added lines, -1 removed lines

@@ -172,7 +172,7 @@
 	 * @param array $post_types - other post types.
 	 *
 	 * @see hook 'rest_api_allowed_post_types'
-	 * @return array
+	 * @return string[]
 	 */
 	public function allow_rest_api_types( $post_types ) {
 		$post_types[] = self::$post_type_plan;

_inc/lib/class.media.php

Doc Comments +7 added lines, -3 removed lines

@@ -86,7 +86,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(
@@ -253,7 +253,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 ) {
@@ -281,6 +281,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
@@ -296,7 +299,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 );
@@ -366,6 +369,7 @@ 
 	 * 
 	 * @param  number $media_id - media post ID
 	 * @param  number [$limit] - maximun amount of items. 20 as default.
+	 * @param integer $limit
 	 * @return array items removed from `revision_history`
 	 */
 	public static function limit_revision_history( $media_id, $limit = null) {

_inc/lib/tonesque.php

Doc Comments +1 added lines, -1 removed lines

@@ -87,7 +87,7 @@
 	 * Construct object from image.
 	 *
 	 * @param optional $type (hex, rgb, hsv)
-	 * @return color as a string formatted as $type
+	 * @return false|string as a string formatted as $type
 	 *
  	 */
 	function color( $type = 'hex' ) {

modules/photon-cdn.php

Doc Comments +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
 	 *
 	 * @param String $plugin_slug plugin slug string.
 	 * @param String $current_version plugin version string.
-	 * @return null|bool
+	 * @return false|null
 	 */
 	public static function cdnize_plugin_assets( $plugin_slug, $current_version ) {
 		global $wp_scripts, $wp_styles;

_inc/lib/class.jetpack-keyring-service-helper.php

Doc Comments +8 added lines

@@ -100,6 +100,10 @@ 
 		), menu_page_url( 'sharing', false ) );
 	}
 
+	/**
+	 * @param string $service_name
+	 * @param string $for
+	 */
 	static function refresh_url( $service_name, $for ) {
 		return add_query_arg( array(
 			'action'   => 'request',
@@ -111,6 +115,10 @@ 
 		), admin_url( 'options-general.php?page=sharing' ) );
 	}
 
+	/**
+	 * @param string $service_name
+	 * @param string $id
+	 */
 	static function disconnect_url( $service_name, $id ) {
 		return add_query_arg( array(
 			'action'   => 'delete',