Automattic / jetpack

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

modules/publicize/ui.php

Doc Comments +1 added lines, -1 removed lines

@@ -415,7 +415,7 @@
 	 *
 	 * @param array $connections_data
 	 *
-	 * @return array {
+	 * @return string {
 	 *     Array of content for generating connection form.
 	 *
 	 *     @type string HTML content of form

modules/publicize/publicize-jetpack.php

Doc Comments +3 added lines

@@ -682,6 +682,9 @@
 		$this->options_save_other( 'linkedin' );
 	}
 
+	/**
+	 * @param string $service_name
+	 */
 	function options_save_other( $service_name ) {
 		// Nonce check
 		check_admin_referer( 'save_' . $service_name . '_token_' . $_REQUEST['connection'] );

modules/shortcodes/soundcloud.php

Doc Comments +2 added lines, -2 removed lines

@@ -142,7 +142,7 @@ 
 /**
  * Plugin options getter
  *
- * @param  string|array $option  Option name.
+ * @param  string $option  Option name.
  * @param  mixed        $default Default value.
  *
  * @return mixed                   Option value
@@ -158,7 +158,7 @@ 
  *
  * @param string $url Soundcloud URL.
  *
- * @return boolean
+ * @return integer
  */
 function soundcloud_url_has_tracklist( $url ) {
 	return preg_match( '/^(.+?)\/(sets|groups|playlists)\/(.+?)$/', $url );

modules/sharedaddy/sharing-sources.php

Doc Comments +6 added lines

@@ -339,6 +339,9 @@ 
 		do_action( 'sharing_bump_stats', array( 'service' => $this, 'post' => $post ) );
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function js_dialog( $name, $params = array() ) {
 		if ( true !== $this->open_link_in_new ) {
 			return;
@@ -1458,6 +1461,9 @@ 
 		return __( 'Pinterest', 'jetpack' );
 	}
 
+	/**
+	 * @return string
+	 */
 	public function get_image( $post ) {
 		if ( class_exists( 'Jetpack_PostImages' ) ) {
 			$image = Jetpack_PostImages::get_image( $post->ID, array( 'fallback_to_avatars' => true ) );

modules/notes.php

Doc Comments +3 added lines

@@ -36,6 +36,9 @@
 		add_action( 'init', array( &$this, 'action_init' ) );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	function wpcom_static_url($file) {
 		$i = hexdec( substr( md5( $file ), -1 ) ) % 2;
 		return 'https://s' . $i . '.wp.com' . $file;

sal/class.json-api-links.php

Doc Comments +2 added lines, -1 removed lines

@@ -30,6 +30,7 @@ 
 	 * Used to construct meta links in API responses
 	 *
 	 * @param mixed ...$args Optional arguments to be appended to URL
+	 * @param string $args
 	 * @return string Endpoint URL
 	 **/
 	function get_link( ...$args ) {
@@ -128,7 +129,7 @@ 
 	 * This method is used in get_link() to construct meta links for API responses.
 	 *
 	 * @param $template_path string The generic endpoint path, e.g. /sites/%s
-	 * @param $path string The current endpoint path, relative to the version, e.g. /sites/12345
+	 * @param string $path string The current endpoint path, relative to the version, e.g. /sites/12345
 	 * @param $request_method string Request method used to access the endpoint path
 	 * @return string The current version, or otherwise the maximum version available
 	 */

packages/connection/legacy/class-jetpack-signature.php

Doc Comments +1 added lines, -1 removed lines

@@ -165,7 +165,7 @@
 	 * @param string $url              Request URL.
 	 * @param mixed  $body             Request body.
 	 * @param bool   $verify_body_hash Whether to verify the body hash against the body.
-	 * @return string|WP_Error Request signature, or a WP_Error on failure.
+	 * @return string Request signature, or a WP_Error on failure.
 	 */
 	public function sign_request( $token = '', $timestamp = 0, $nonce = '', $body_hash = '', $method = '', $url = '', $body = null, $verify_body_hash = true ) {
 		if ( ! $this->secret ) {

packages/options/legacy/class-jetpack-options.php

Doc Comments +3 added lines, -3 removed lines

@@ -27,7 +27,7 @@ 
 	 *
 	 * @param string $type The type of option to return. Defaults to 'compact'.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function get_option_names( $type = 'compact' ) {
 		switch ( $type ) {
@@ -505,7 +505,7 @@ 
 	 * @since 5.4.0
 	 *
 	 * @param boolean $strip_unsafe_options If true, and by default, will strip out options necessary for the connection to WordPress.com.
-	 * @return array An array of all options managed via the Jetpack_Options class.
+	 * @return string[] An array of all options managed via the Jetpack_Options class.
 	 */
 	public static function get_all_jetpack_options( $strip_unsafe_options = true ) {
 		$jetpack_options            = self::get_option_names();
@@ -548,7 +548,7 @@ 
 	 *
 	 * @since 5.4.0
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function get_all_wp_options() {
 		// A manual build of the wp options.