Completed
Push — fix/search-exit-behaviour ( 2470c6...a5bcca )
by
unknown
113:52 queued 104:31
created
_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -159,7 +159,7 @@
 block discarded – undo
159 159
 	 *
160 160
 	 * @since 4.3.0
161 161
 	 *
162
-	 * @return array Array of Jetpack modules.
162
+	 * @return string Array of Jetpack modules.
163 163
 	 */
164 164
 	public function get_modules() {
165 165
 		require_once( JETPACK__PLUGIN_DIR . 'class.jetpack-admin.php' );
Please login to merge, or discard this patch.
_inc/lib/class.core-rest-api-endpoints.php 1 patch
Doc Comments   +2 added lines, -4 removed lines patch added patch discarded remove patch
@@ -536,7 +536,6 @@  discard block
 block discarded – undo
536 536
 	 * @uses Jetpack::disconnect();
537 537
 	 * @since 4.3.0
538 538
 	 *
539
-	 * @param WP_REST_Request $request The request sent to the WP REST API.
540 539
 	 *
541 540
 	 * @return string|WP_Error A raw URL if the connection URL could be built; error message otherwise.
542 541
 	 */
@@ -556,7 +555,6 @@  discard block
 block discarded – undo
556 555
 	 *
557 556
 	 * @since 4.3.0
558 557
 	 *
559
-	 * @param WP_REST_Request $request The request sent to the WP REST API.
560 558
 	 *
561 559
 	 * @return object
562 560
 	 */
@@ -1966,7 +1964,7 @@  discard block
 block discarded – undo
1966 1964
 	 *
1967 1965
 	 * @param string $route Regular expression for the endpoint with the module slug to return.
1968 1966
 	 *
1969
-	 * @return array
1967
+	 * @return string
1970 1968
 	 */
1971 1969
 	public static function get_module_requested( $route = '/module/(?P<slug>[a-z\-]+)' ) {
1972 1970
 
@@ -1991,7 +1989,7 @@  discard block
 block discarded – undo
1991 1989
 	 * @param string      $modules Can be a single module or a list of modules.
1992 1990
 	 * @param null|string $slug    Slug of the module in the first parameter.
1993 1991
 	 *
1994
-	 * @return array
1992
+	 * @return string
1995 1993
 	 */
1996 1994
 	public static function prepare_modules_for_response( $modules = '', $slug = null ) {
1997 1995
 		if ( get_option( 'permalink_structure' ) ) {
Please login to merge, or discard this patch.
class.json-api.php 1 patch
Doc Comments   +17 added lines patch added patch discarded remove patch
@@ -31,6 +31,9 @@  discard block
 block discarded – undo
31 31
 	public $did_output = false;
32 32
 
33 33
 	/**
34
+	 * @param string $method
35
+	 * @param string $url
36
+	 * @param string $post_body
34 37
 	 * @return WPCOM_JSON_API instance
35 38
 	 */
36 39
 	static function init( $method = null, $url = null, $post_body = null ) {
@@ -332,6 +335,9 @@  discard block
 block discarded – undo
332 335
 		return call_user_func_array( array( $endpoint, 'callback' ), $path_pieces );
333 336
 	}
334 337
 
338
+	/**
339
+	 * @param integer $status_code
340
+	 */
335 341
 	function output_early( $status_code, $response = null, $content_type = 'application/json' ) {
336 342
 		$exit = $this->exit;
337 343
 		$this->exit = false;
@@ -526,11 +532,18 @@  discard block
 block discarded – undo
526 532
 		return json_encode( $data );
527 533
 	}
528 534
 
535
+	/**
536
+	 * @param string $needle
537
+	 */
529 538
 	function ends_with( $haystack, $needle ) {
530 539
 		return $needle === substr( $haystack, -strlen( $needle ) );
531 540
 	}
532 541
 
533 542
 	// Returns the site's blog_id in the WP.com ecosystem
543
+
544
+	/**
545
+	 * @return integer
546
+	 */
534 547
 	function get_blog_id_for_output() {
535 548
 		return $this->token_details['blog_id'];
536 549
 	}
@@ -553,6 +566,10 @@  discard block
 block discarded – undo
553 566
 	}
554 567
 
555 568
 	// Returns true if the specified blog ID is a restricted blog
569
+
570
+	/**
571
+	 * @param integer $blog_id
572
+	 */
556 573
 	function is_restricted_blog( $blog_id ) {
557 574
 		/**
558 575
 		 * Filters all REST API access and return a 403 unauthorized response for all Restricted blog IDs.
Please login to merge, or discard this patch.
_inc/lib/class.media.php 1 patch
Doc Comments   +6 added lines, -3 removed lines patch added patch discarded remove patch
@@ -87,7 +87,7 @@  discard block
 block discarded – undo
87 87
 	/**
88 88
 	 * Return an array of allowed mime_type items used to upload a media file.
89 89
 	 * 	
90
-	 * @return array mime_type array
90
+	 * @return string[] mime_type array
91 91
 	 */
92 92
 	static function get_allowed_mime_types( $default_mime_types ) {
93 93
 		return array_unique( array_merge( $default_mime_types, array(
@@ -254,7 +254,7 @@  discard block
 block discarded – undo
254 254
 	 * @param  object $media_item - media post object
255 255
 	 * @param  file $file - file recently added
256 256
 	 * @param  bool $has_original_media - condition is the original media has been already added
257
-	 * @return bool `true` if the item has been added. Otherwise `false`.
257
+	 * @return false|null `true` if the item has been added. Otherwise `false`.
258 258
 	 */
259 259
 	public static function register_revision( $media_item, $file, $has_original_media ) {
260 260
 		if ( is_wp_error( $file ) || ! $has_original_media ) {
@@ -282,6 +282,9 @@  discard block
 block discarded – undo
282 282
 		return $original;
283 283
 	}
284 284
 
285
+	/**
286
+	 * @param string $pathname
287
+	 */
285 288
 	public static function delete_file( $pathname ) {
286 289
 		if ( ! file_exists( $pathname ) || ! is_file( $pathname ) ) {
287 290
 			// let's touch a fake file to try to `really` remove the media file
@@ -297,7 +300,7 @@  discard block
 block discarded – undo
297 300
 	 * 
298 301
 	 * @param  number $media_id - media post ID
299 302
 	 * @param  string $filename - basename of the file ( name-of-file.ext )
300
-	 * @return bool `true` is the file has been removed, `false` if not.
303
+	 * @return boolean|null `true` is the file has been removed, `false` if not.
301 304
 	 */
302 305
 	private static function delete_media_history_file( $media_id, $filename ) {
303 306
 		$attached_path = get_attached_file( $media_id );
Please login to merge, or discard this patch.
json-endpoints/class.wpcom-json-api-edit-media-v1-2-endpoint.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -7,7 +7,7 @@  discard block
 block discarded – undo
7 7
 	 * Update the media post grabbing the post values from
8 8
 	 * the `attrs` parameter
9 9
 	 *
10
-	 * @param  {Number} $media_id - post media ID
10
+	 * @param  integer $media_id - post media ID
11 11
 	 * @param  {Object} $attrs - `attrs` parameter sent from the client in the request body
12 12
 	 * @return bool|WP_Error `WP_Error` on failure. `true` on success.
13 13
 	 */
@@ -64,7 +64,7 @@  discard block
 block discarded – undo
64 64
 	/**
65 65
 	 * Get the image from a remote url and then save it locally.
66 66
 	 *
67
-	 * @param  {Number} $media_id - media post ID
67
+	 * @param  integer $media_id - media post ID
68 68
 	 * @param  {String} $url - image URL to save locally
69 69
 	 * @return {Array|WP_Error} An array with information about the new file saved or a WP_Error is something went wrong.
70 70
 	 */
Please login to merge, or discard this patch.