Automattic / jetpack

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

Doc Comments +9 added lines, -6 removed lines

@@ -85,7 +85,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 ) {
 		$this->weighting_functions[] = $function;
@@ -100,10 +100,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;
@@ -119,10 +119,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;
@@ -137,7 +137,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;
@@ -163,6 +163,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $aggs_name
+	 */
 	public function add_aggs( $aggs_name, $aggs ) {
 		$this->aggs_query = true;
 		$this->aggs[$aggs_name] = $aggs;

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/sharedaddy/sharing-service.php

Doc Comments +3 added lines

@@ -505,6 +505,9 @@
 	public $service = '';
 	public $total   = 0;
 
+	/**
+	 * @param integer $total
+	 */
 	public function __construct( $id, $total ) {
 		$services      = new Sharing_Service();
 		$this->id      = esc_html( $id );

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/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',

modules/protect/math-fallback.php

Doc Comments +2 added lines, -2 removed lines

@@ -26,7 +26,7 @@ 
 		/**
 		 * Verifies that a user answered the math problem correctly while logging in.
 		 *
-		 * @return bool Returns true if the math is correct
+		 * @return boolean|null Returns true if the math is correct
 		 * @throws Error if insuffient $_POST variables are present.
 		 * @throws Error message if the math is wrong
 		 */
@@ -109,7 +109,7 @@ 
 		/**
 		 * Requires a user to solve a simple equation. Added to any WordPress login form.
 		 *
-		 * @return VOID outputs html
+		 * @return string|null outputs html
 		 */
 		static function math_form() {
 			// Check if jpp_math_pass cookie is set and it matches valid transient