Automattic / jetpack

projects/plugins/jetpack/tests/php/json-api/test-class.json-api-plugins-endpoints.php

Doc Comments +3 added lines

@@ -161,6 +161,9 @@
 		return 'direct';
 	}
 
+	/**
+	 * @param string $dir
+	 */
 	function rmdir( $dir ) {
 		foreach ( scandir( $dir ) as $file ) {
 			if ( is_dir( $file ) )

projects/plugins/jetpack/tests/php/media/test-class.jetpack-media-extractor.php

Doc Comments +3 added lines

@@ -199,6 +199,9 @@
 		$this->assertEquals( $image_list, $images_extracted );
 	}
 
+	/**
+	 * @return integer
+	 */
 	private function add_test_post() {
 		$post_id = $this->factory->post->create( array(
 			'post_author' => '1046316',

projects/plugins/jetpack/tests/php/modules/publicize/test_class.publicize.php

Doc Comments +3 added lines

@@ -139,6 +139,9 @@
 		unregister_post_type( 'foo' );
 	}
 
+	/**
+	 * @param boolean $should_have_publicized
+	 */
 	function assertPublicized( $should_have_publicized, $post ) {
 		if ( $should_have_publicized ) {
 			$this->assertEquals( $post->ID, $this->publicized_post_id, 'Is not the same post ID' );

projects/plugins/jetpack/tests/php/lib/wpcom-helper-functions.php

Doc Comments +1 added lines

@@ -13,6 +13,7 @@
 
 /**
  * Wrapper around `WP_REST_Request` constructor. Injects a `sites/$blog_id` into endpoint string for WPCOM environment
+ * @param string $path
  */
 function wp_rest_request( $method, $path ) {
 	if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {

projects/plugins/jetpack/_inc/lib/core-api/wpcom-fields/class-wpcom-rest-api-v2-attachment-videopress-data.php

Doc Comments +5 added lines, -5 removed lines

@@ -103,7 +103,7 @@ 
 	 *
 	 * @param object $attachment The attachment object.
 	 *
-	 * @return false|int
+	 * @return boolean
 	 */
 	public function is_video( $attachment ) {
 		return isset( $attachment->post_mime_type ) && wp_startswith( $attachment->post_mime_type, 'video/' );
@@ -113,8 +113,8 @@ 
 	 * Removes the jetpack_videopress field from the response if the
 	 * given attachment is not a video.
 	 *
-	 * @param WP_REST_Response $response Response from the attachment endpoint.
-	 * @param WP_Post          $attachment The original attachment object.
+	 * @param stdClass $response Response from the attachment endpoint.
+	 * @param stdClass          $attachment The original attachment object.
 	 *
 	 * @return mixed
 	 */
@@ -146,7 +146,7 @@ 
 	 * @param mixed           $object Response from the attachment endpoint.
 	 * @param WP_REST_Request $request Request to the attachment endpoint.
 	 *
-	 * @return true
+	 * @return boolean
 	 */
 	public function get_permission_check( $object, $request ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
 		return true;
@@ -160,7 +160,7 @@ 
 	 * @param WP_Post         $object The attachment object.
 	 * @param WP_REST_Request $request Request to the attachment endpoint.
 	 *
-	 * @return true
+	 * @return boolean
 	 */
 	public function update_permission_check( $value, $object, $request ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
 		return true;

projects/packages/autoloader/src/class-php-autoloader.php

Doc Comments +1 added lines, -1 removed lines

@@ -100,7 +100,7 @@
 	 *
 	 * @param string $class_name The name of the class to autoload.
 	 *
-	 * @return bool Indicates whether or not a class file was loaded.
+	 * @return null|boolean Indicates whether or not a class file was loaded.
 	 */
 	public static function load_class( $class_name ) {
 		global $jetpack_autoloader_loader;

projects/plugins/jetpack/extensions/blocks/premium-content/_inc/subscription-service/class-jwt.php

Doc Comments +1 added lines, -1 removed lines

@@ -186,7 +186,7 @@
 	 * Sign a string with a given key and algorithm.
 	 *
 	 * @param string          $msg    The message to sign.
-	 * @param string|resource $key    The secret key.
+	 * @param string $key    The secret key.
 	 * @param string          $alg    The signing algorithm.
 	 *                                Supported algorithms are 'HS256', 'HS384', 'HS512' and 'RS256'.
 	 *

projects/plugins/jetpack/extensions/blocks/premium-content/_inc/subscription-service/class-token-subscription-service.php

Doc Comments +1 added lines, -1 removed lines

@@ -149,7 +149,7 @@
 	/**
 	 * Get the token stored in the auth cookie.
 	 *
-	 * @return ?string
+	 * @return string
 	 */
 	private function token_from_cookie() {
 		if ( isset( $_COOKIE[ self::JWT_AUTH_TOKEN_COOKIE_NAME ] ) ) {

projects/plugins/jetpack/_inc/lib/jetpack-wpes-query-builder/jetpack-wpes-query-builder.php

Doc Comments +9 added lines, -6 removed lines

@@ -91,7 +91,7 @@ 
 	 *
 	 * @param $function array A function structure to apply to the query
 	 *
-	 * @return void
+	 * @return Jetpack_WPES_Query_Builder
 	 */
 	public function add_weighting_function( $function ) {
 		// check for danger.
@@ -114,10 +114,10 @@ 
 	 *
 	 * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html
 	 *
-	 * @param $function string name of the function
+	 * @param string $function string name of the function
 	 * @param $params array functions parameters
 	 *
-	 * @return void
+	 * @return Jetpack_WPES_Query_Builder
 	 */
 	public function add_function( $function, $params ) {
 		$this->functions[ $function ][] = $params;
@@ -133,10 +133,10 @@ 
 	 *
 	 * @see https://www.elastic.co/guide/en/elasticsearch/guide/current/decay-functions.html
 	 *
-	 * @param $function string name of the decay function - linear, exp, or gauss
+	 * @param string $function string name of the decay function - linear, exp, or gauss
 	 * @param $params array The decay functions parameters, passed to ES directly
 	 *
-	 * @return void
+	 * @return Jetpack_WPES_Query_Builder
 	 */
 	public function add_decay( $function, $params ) {
 		$this->decays[ $function ][] = $params;
@@ -151,7 +151,7 @@ 
 	 *
 	 * @param $mode string name of how to score
 	 *
-	 * @return void
+	 * @return Jetpack_WPES_Query_Builder
 	 */
 	public function add_score_mode_to_functions( $mode='multiply' ) {
 		$this->functions_score_mode = $mode;
@@ -177,6 +177,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $aggs_name
+	 */
 	public function add_aggs( $aggs_name, $aggs ) {
 		$this->aggs_query = true;
 		$this->aggs[$aggs_name] = $aggs;