Automattic / jetpack

packages/lazy-images/src/lazy-images.php

Doc Comments +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
 	 *
 	 * @since 5.6.0
 	 *
-	 * @return object The class instance.
+	 * @return Jetpack_Lazy_Images The class instance.
 	 */
 	public static function instance() {
 		if ( is_null( self::$instance ) ) {

packages/connection/src/class-manager.php

Doc Comments +4 added lines, -3 removed lines

@@ -313,7 +313,7 @@ 
 	/**
 	 * Verifies the signature of the current request.
 	 *
-	 * @return false|array
+	 * @return boolean
 	 */
 	public function verify_xml_rpc_signature() {
 		if ( is_null( $this->xmlrpc_verification ) ) {
@@ -1286,6 +1286,7 @@ 
 	 * @param String  $action  The action name.
 	 * @param Integer $user_id The user identifier.
 	 * @param Integer $exp     Expiration time in seconds.
+	 * @return string
 	 */
 	public function generate_secrets( $action, $user_id = false, $exp = 600 ) {
 		if ( false === $user_id ) {
@@ -2242,7 +2243,7 @@ 
 	 *
 	 * @param int|false    $user_id   false: Return the Blog Token. int: Return that user's User Token.
 	 * @param string|false $token_key If provided, check that the token matches the provided input.
-	 * @param bool|true    $suppress_errors If true, return a falsy value when the token isn't found; When false, return a descriptive WP_Error when the token isn't found.
+	 * @param boolean    $suppress_errors If true, return a falsy value when the token isn't found; When false, return a descriptive WP_Error when the token isn't found.
 	 *
 	 * @return object|false
 	 */
@@ -2626,7 +2627,7 @@ 
 	 * Fetches a signed token.
 	 *
 	 * @param object $token the token.
-	 * @return WP_Error|string a signed token
+	 * @return string a signed token
 	 */
 	public function get_signed_token( $token ) {
 		if ( ! isset( $token->secret ) || empty( $token->secret ) ) {

packages/tracking/src/class-tracking.php

Doc Comments +2 added lines, -2 removed lines

@@ -119,8 +119,8 @@
 	/**
 	 * Determines whether tracking should be enabled.
 	 *
-	 * @param Automattic\Jetpack\Terms_Of_Service $terms_of_service A Terms_Of_Service object.
-	 * @param Automattic\Jetpack\Status           $status A Status object.
+	 * @param Terms_Of_Service $terms_of_service A Terms_Of_Service object.
+	 * @param Status           $status A Status object.
 	 *
 	 * @return boolean True if tracking should be enabled, else false.
 	 */

packages/sync/src/interface-replicastore.php

Doc Comments +34 added lines

@@ -20,6 +20,7 @@ 
 	 * Empty and reset the replicastore.
 	 *
 	 * @access public
+	 * @return void
 	 */
 	public function reset();
 
@@ -29,6 +30,7 @@ 
 	 * @access public
 	 *
 	 * @param array $config Full sync configuration for this sync module.
+	 * @return void
 	 */
 	public function full_sync_start( $config );
 
@@ -38,6 +40,7 @@ 
 	 * @access public
 	 *
 	 * @param string $checksum Deprecated since 7.3.0.
+	 * @return void
 	 */
 	public function full_sync_end( $checksum );
 
@@ -51,6 +54,7 @@ 
 	 * @param string $status Post status.
 	 * @param int    $min_id Minimum post ID.
 	 * @param int    $max_id Maximum post ID.
+	 * @return integer
 	 */
 	public function post_count( $status = null, $min_id = null, $max_id = null );
 
@@ -81,6 +85,7 @@ 
 	 *
 	 * @param \WP_Post $post   Post object.
 	 * @param bool     $silent Whether to perform a silent action.
+	 * @return void
 	 */
 	public function upsert_post( $post, $silent = false );
 
@@ -90,6 +95,7 @@ 
 	 * @access public
 	 *
 	 * @param int $post_id Post ID.
+	 * @return void
 	 */
 	public function delete_post( $post_id );
 
@@ -121,6 +127,7 @@ 
 	 * @param string $status Comment status.
 	 * @param int    $min_id Minimum comment ID.
 	 * @param int    $max_id Maximum comment ID.
+	 * @return integer
 	 */
 	public function comment_count( $status = null, $min_id = null, $max_id = null );
 
@@ -150,6 +157,7 @@ 
 	 * @access public
 	 *
 	 * @param \WP_Comment $comment Comment object.
+	 * @return void
 	 */
 	public function upsert_comment( $comment );
 
@@ -159,6 +167,7 @@ 
 	 * @access public
 	 *
 	 * @param int $comment_id Comment ID.
+	 * @return void
 	 */
 	public function trash_comment( $comment_id );
 
@@ -168,6 +177,7 @@ 
 	 * @access public
 	 *
 	 * @param int $comment_id Comment ID.
+	 * @return void
 	 */
 	public function spam_comment( $comment_id );
 
@@ -177,6 +187,7 @@ 
 	 * @access public
 	 *
 	 * @param int $comment_id Comment ID.
+	 * @return void
 	 */
 	public function delete_comment( $comment_id );
 
@@ -187,6 +198,7 @@ 
 	 *
 	 * @param int   $post_id  Post ID.
 	 * @param array $statuses Post statuses.
+	 * @return void
 	 */
 	public function trashed_post_comments( $post_id, $statuses );
 
@@ -196,6 +208,7 @@ 
 	 * @access public
 	 *
 	 * @param int $post_id Post ID.
+	 * @return void
 	 */
 	public function untrashed_post_comments( $post_id );
 
@@ -226,6 +239,7 @@ 
 	 *
 	 * @param string $option Option name.
 	 * @param mixed  $value  Option value.
+	 * @return boolean
 	 */
 	public function update_option( $option, $value );
 
@@ -245,6 +259,7 @@ 
 	 * @access public
 	 *
 	 * @param string $option Name of option to remove.
+	 * @return boolean
 	 */
 	public function delete_option( $option );
 
@@ -254,6 +269,7 @@ 
 	 * @access public
 	 *
 	 * @param array $theme_info Theme info array.
+	 * @return void
 	 */
 	public function set_theme_info( $theme_info );
 
@@ -288,6 +304,7 @@ 
 	 * @param string $meta_key   Meta key.
 	 * @param mixed  $meta_value Meta value.
 	 * @param int    $meta_id    ID of the meta.
+	 * @return boolean
 	 */
 	public function upsert_metadata( $type, $object_id, $meta_key, $meta_value, $meta_id );
 
@@ -299,6 +316,7 @@ 
 	 * @param string $type      Meta type.
 	 * @param int    $object_id ID of the object.
 	 * @param array  $meta_ids  IDs of the meta objects to delete.
+	 * @return false|null
 	 */
 	public function delete_metadata( $type, $object_id, $meta_ids );
 
@@ -310,6 +328,7 @@ 
 	 * @param string $type       Meta type.
 	 * @param array  $object_ids IDs of the objects.
 	 * @param string $meta_key   Meta key.
+	 * @return false|null
 	 */
 	public function delete_batch_metadata( $type, $object_ids, $meta_key );
 
@@ -329,6 +348,7 @@ 
 	 *
 	 * @param string $constant Name of constant to retrieve.
 	 * @param mixed  $value    Value set for the constant.
+	 * @return void
 	 */
 	public function set_constant( $constant, $value );
 
@@ -339,6 +359,7 @@ 
 	 * @access public
 	 *
 	 * @param string $type Type of updates to retrieve.
+	 * @return integer|null
 	 */
 	public function get_updates( $type );
 
@@ -350,6 +371,7 @@ 
 	 *
 	 * @param string $type    Type of updates to set.
 	 * @param int    $updates Total number of updates.
+	 * @return void
 	 */
 	public function set_updates( $type, $updates );
 
@@ -369,6 +391,7 @@ 
 	 *
 	 * @param string $callable Callable name.
 	 * @param mixed  $value    Callable value.
+	 * @return void
 	 */
 	public function set_callable( $callable, $value );
 
@@ -388,6 +411,7 @@ 
 	 *
 	 * @param string $option Network option name.
 	 * @param mixed  $value  Network option value.
+	 * @return boolean
 	 */
 	public function update_site_option( $option, $value );
 
@@ -397,6 +421,7 @@ 
 	 * @access public
 	 *
 	 * @param string $option Name of option to remove.
+	 * @return boolean
 	 */
 	public function delete_site_option( $option );
 
@@ -458,6 +483,7 @@ 
 	 * @param string           $taxonomy  The context in which to relate the term to the object.
 	 * @param string|int|array $terms     A single term slug, single term id, or array of either term slugs or ids.
 	 * @param bool             $append    Optional. If false will delete difference of terms. Default false.
+	 * @return void
 	 */
 	public function update_object_terms( $object_id, $taxonomy, $terms, $append );
 
@@ -470,6 +496,7 @@ 
 	 *
 	 * @param int   $object_id ID of the object.
 	 * @param array $tt_ids    Term taxonomy IDs.
+	 * @return boolean
 	 */
 	public function delete_object_terms( $object_id, $tt_ids );
 
@@ -477,6 +504,7 @@ 
 	 * Retrieve the number of users.
 	 *
 	 * @access public
+	 * @return void
 	 */
 	public function user_count();
 
@@ -495,6 +523,7 @@ 
 	 * @access public
 	 *
 	 * @param \WP_User $user User object.
+	 * @return void
 	 */
 	public function upsert_user( $user );
 
@@ -504,6 +533,7 @@ 
 	 * @access public
 	 *
 	 * @param int $user_id User ID.
+	 * @return void
 	 */
 	public function delete_user( $user_id );
 
@@ -514,6 +544,7 @@ 
 	 *
 	 * @param int    $user_id User ID.
 	 * @param string $locale  The user locale.
+	 * @return void
 	 */
 	public function upsert_user_locale( $user_id, $locale );
 
@@ -523,6 +554,7 @@ 
 	 * @access public
 	 *
 	 * @param int $user_id User ID.
+	 * @return void
 	 */
 	public function delete_user_locale( $user_id );
 
@@ -532,6 +564,7 @@ 
 	 * @access public
 	 *
 	 * @param int $user_id User ID.
+	 * @return string
 	 */
 	public function get_user_locale( $user_id );
 
@@ -541,6 +574,7 @@ 
 	 * @access public
 	 *
 	 * @param int $user_id User ID.
+	 * @return void
 	 */
 	public function get_allowed_mime_types( $user_id );
 

modules/videopress/class.videopress-video.php

Doc Comments +2 added lines, -1 removed lines

@@ -174,6 +174,7 @@ 
 	 * @since 1.3
 	 * @var string $guid VideoPress unique identifier
 	 * @var int $maxwidth maximum requested video width. final width and height are calculated on VideoPress servers based on the aspect ratio of the original video upload.
+	 * @param string $guid
 	 */
 	public function __construct( $guid, $maxwidth = 640 ) {
 		$this->guid = $guid;
@@ -311,7 +312,7 @@ 
 	 *
 	 * @since 1.2
 	 * @param string $url absolute URL
-	 * @return bool|string host component of the URL, or false if none found
+	 * @return string|false host component of the URL, or false if none found
 	 */
 	public static function hostname( $url ) {
 		return wp_parse_url( esc_url_raw( $url ), PHP_URL_HOST );

packages/sync/src/class-replicastore.php

Doc Comments +1 added lines, -1 removed lines

@@ -325,7 +325,7 @@
 	 * @access protected
 	 *
 	 * @param string $status Comment status.
-	 * @return string|bool New comment_approved value, false if the status doesn't affect it.
+	 * @return string|false New comment_approved value, false if the status doesn't affect it.
 	 */
 	protected function comment_status_to_approval_value( $status ) {
 		switch ( (string) $status ) {

modules/widgets/rsslinks-widget.php

Doc Comments +4 added lines, -1 removed lines

@@ -62,7 +62,7 @@ 
 	 * Return an associative array of default values
 	 * These values are used in new widgets as well as when sanitizing input.
 	 *
-	 * @return array Array of default values for the Widget's options
+	 * @return string Array of default values for the Widget's options
 	 */
 	function defaults() {
 		return array(
@@ -172,6 +172,9 @@ 
 		echo '</select></label></p></div>';
 	}
 
+	/**
+	 * @param string $type
+	 */
 	function _rss_link( $type, $args ) {
 		if ( 'posts' == $type ) {
 			$type_text = __( 'Posts', 'jetpack' );

packages/connection/tests/php/test_Signature.php

Doc Comments +1 added lines, -1 removed lines

@@ -220,7 +220,7 @@
 	 * Also used by @see self::test_request_port_constants
 	 *
 	 * @param mixed   $http_x_forwarded_port value of $_SERVER[ 'HTTP_X_FORWARDED_PORT' ].
-	 * @param mixed   $server_port value of $_SERVER[ 'SERVER_PORT' ]. Null will unset the value.
+	 * @param string   $server_port value of $_SERVER[ 'SERVER_PORT' ]. Null will unset the value.
 	 * @param string  $expeceted The expected output. Null will unset the value.
 	 * @param boolean $ssl Whether to consider current request using SSL or not.
 	 *

modules/widgets/milestone/class-milestone-widget.php

Doc Comments +1 added lines, -1 removed lines

@@ -595,7 +595,7 @@
 	 *
 	 * @param array $dirty Unsantized data for the widget.
 	 *
-	 * @return array Santized data.
+	 * @return integer Santized data.
 	 */
 	public function sanitize_instance( $dirty ) {
 		$now = (int) current_time( 'timestamp' ); // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.Requested