Automattic / jetpack

modules/sitemaps/sitemap-buffer.php

Doc Comments +3 added lines, -3 removed lines

@@ -136,7 +136,7 @@ 
 	 *
 	 * @param string $item The item to be added.
 	 *
-	 * @return bool True if the append succeeded, False if not.
+	 * @return boolean|null True if the append succeeded, False if not.
 	 */
 	public function try_to_add_item( $item ) {
 		_deprecated_function(
@@ -155,7 +155,7 @@ 
 	 *
 	 * @since 5.3.0
 	 *
-	 * @param array $array The item to be added.
+	 * @param string $array The item to be added.
 	 *
 	 * @return bool True if the append succeeded, False if not.
 	 */
@@ -280,7 +280,7 @@ 
 	 * @param DOMElement $parent (optional) an element to which new children should be added.
 	 * @param DOMDocument $root (optional) the parent document.
 	 *
-	 * @return string|DOMDocument The rendered XML string or an object if root element is specified.
+	 * @return null|DOMNode The rendered XML string or an object if root element is specified.
 	 */
 	protected function array_to_xml_string( $array, $parent = null, $root = null ) {
 		$return_string = false;

3rd-party/qtranslate-x.php

Doc Comments +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
  * @param string $url_orig Original URL.
  * @param array $url_info  Pieces of original URL.
  *
- * @return bool
+ * @return false|string
  */
 function jetpack_no_qtranslate_rest_url_redirect( $url_lang, $url_orig, $url_info ) {
 	if ( false !== strpos( $url_info['wp-path'], 'wp-json/jetpack' ) ) {

modules/wordads/wordads.php

Doc Comments +2 added lines, -2 removed lines

@@ -46,7 +46,7 @@ 
 	/**
 	 * Convenience function for grabbing options from params->options
 	 * @param  string $option the option to grab
-	 * @param  mixed  $default (optional)
+	 * @param  boolean  $default (optional)
 	 * @return option or $default if not set
 	 *
 	 * @since 4.5.0
@@ -395,7 +395,7 @@ 
 
 	/**
 	 * Check the reasons to bail before we attempt to insert ads.
-	 * @return true if we should bail (don't insert ads)
+	 * @return boolean if we should bail (don't insert ads)
 	 *
 	 * @since 4.5.0
 	 */

_inc/lib/class.core-rest-api-endpoints.php

Doc Comments -2 removed lines

@@ -598,7 +598,6 @@ 
 	 * @uses Jetpack::disconnect();
 	 * @since 4.3.0
 	 *
-	 * @param WP_REST_Request $request The request sent to the WP REST API.
 	 *
 	 * @return string|WP_Error A raw URL if the connection URL could be built; error message otherwise.
 	 */
@@ -618,7 +617,6 @@ 
 	 *
 	 * @since 4.3.0
 	 *
-	 * @param WP_REST_Request $request The request sent to the WP REST API.
 	 *
 	 * @return object
 	 */

json-endpoints/class.wpcom-json-api-site-user-endpoint.php

Doc Comments +1 added lines

@@ -63,6 +63,7 @@
 	/**
 	 * Updates user data
 	 *
+	 * @param integer $user_id
 	 * @return array
 	 */
 	public function update_user( $user_id, $blog_id ) {

class.jetpack-xmlrpc-server.php

Doc Comments +1 added lines

@@ -242,6 +242,7 @@
 	/**
 	 * Returns the current error as an IXR_Error
 	 *
+	 * @param string $tracks_event_name
 	 * @return bool|IXR_Error
 	 */
 	function error( $error = null, $tracks_event_name = null, $user = null ) {

modules/masterbar/masterbar.php

Doc Comments +6 added lines

@@ -125,6 +125,9 @@ 
 		wp_enqueue_script( 'a8c_wpcom_masterbar_overrides', $this->wpcom_static_url( '/wp-content/mu-plugins/admin-bar/masterbar-overrides/masterbar.js' ), array( 'jquery' ), JETPACK__VERSION );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	function wpcom_static_url( $file ) {
 		if ( ! empty( $this->sandbox_url ) ) {
 			// For testing undeployed changes to remotely enqueued scripts and styles.
@@ -307,6 +310,9 @@ 
 		return $primary_anchor . $secondary_anchor;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function create_menu_item_anchor( $class, $url, $label, $id ) {
 		return '<a href="' . $url . '" class="' . $class . '" id="' . $id . '">' . $label . '</a>';
 	}

class.jetpack.php

Doc Comments +43 added lines, -16 removed lines

@@ -1024,7 +1024,7 @@ 
 	}
 	/**
 	 * Does the network allow admins to add new users.
-	 * @return boolian
+	 * @return boolean
 	 */
 	static function network_add_new_users( $option = null ) {
 		return (bool) get_site_option( 'add_new_users' );
@@ -1129,7 +1129,7 @@ 
 	 * database which could be set to anything as opposed to what this function returns.
 	 * @param  bool  $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1140,7 +1140,7 @@ 
 	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
 	 *
 	 * @param  string  $option
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_multisite( $option ) {
 		return (string) (bool) is_multisite();
@@ -1202,7 +1202,7 @@ 
 
 	/**
 	 * Returns true if the site has file write access false otherwise.
-	 * @return string ( '1' | '0' )
+	 * @return integer ( '1' | '0' )
 	 **/
 	public static function file_system_write_access() {
 		if ( ! function_exists( 'get_filesystem_method' ) ) {
@@ -1441,6 +1441,7 @@ 
 	 * @access public
 	 * @static
 	 *
+	 * @param string $feature
 	 * @return bool True if plan supports feature, false if not
 	 */
 	public static function active_plan_supports( $feature ) {
@@ -1977,6 +1978,7 @@ 
 	 * @param int $user_id
 	 * @param string $token
 	 * return bool
+	 * @param boolean $is_master_user
 	 */
 	public static function update_user_token( $user_id, $token, $is_master_user ) {
 		// not designed for concurrent updates
@@ -2371,6 +2373,7 @@ 
 
 	/**
 	 * Like core's get_file_data implementation, but caches the result.
+	 * @param string $file
 	 */
 	public static function get_file_data( $file, $headers ) {
 		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
@@ -2416,7 +2419,7 @@ 
 	 *
 	 * @param string $tag Tag as it appears in each module heading.
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public static function translate_module_tag( $tag ) {
 		return jetpack_get_module_i18n_tag( $tag );
@@ -2519,8 +2522,8 @@ 
 	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
 	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
 	 *
-	 * @param $string
-	 * @return mixed
+	 * @param string $string
+	 * @return string|null
 	 */
 	public static function alias_directories( $string ) {
 		// ABSPATH has a trailing slash.
@@ -2794,6 +2797,9 @@ 
 		return self::update_active_modules( $new );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function enable_module_configurable( $module ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
@@ -2804,21 +2810,33 @@ 
 		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_load( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'jetpack_module_configuration_load_' . $module, $method );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_head( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'jetpack_module_configuration_head_' . $module, $method );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_screen( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_activation_screen( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'display_activate_module_setting_' . $module, $method );
@@ -2826,6 +2844,9 @@ 
 
 /* Installation */
 
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3526,7 +3547,7 @@ 
 	 * Add help to the Jetpack page
 	 *
 	 * @since Jetpack (1.2.3)
-	 * @return false if not the Jetpack page
+	 * @return false|null if not the Jetpack page
 	 */
 	function admin_help() {
 		$current_screen = get_current_screen();
@@ -4577,6 +4598,7 @@ 
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -4735,7 +4757,8 @@ 
 	 * Note these tokens are unique per call, NOT static per site for connecting.
 	 *
 	 * @since 2.6
-	 * @return array
+	 * @param string $action
+	 * @return boolean
 	 */
 	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
 		if ( ! $user_id ) {
@@ -5220,7 +5243,6 @@ 
 	/**
 	 * Report authentication status to the WP REST API.
 	 *
-	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
 	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
 	 */
 	public function wp_rest_authentication_errors( $value ) {
@@ -5230,6 +5252,10 @@ 
 		return $this->rest_authentication_status;
 	}
 
+	/**
+	 * @param integer $timestamp
+	 * @param string $nonce
+	 */
 	function add_nonce( $timestamp, $nonce ) {
 		global $wpdb;
 		static $nonces_used_this_request = array();
@@ -5375,6 +5401,7 @@ 
 	 * @param string $key
 	 * @param string $value
 	 * @param bool $restate private
+	 * @return string
 	 */
 	public static function state( $key = null, $value = null, $restate = false ) {
 		static $state = array();
@@ -5431,6 +5458,9 @@ 
 		Jetpack::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -6027,9 +6057,7 @@ 
 	 *
 	 * Attached to `style_loader_src` filter.
 	 *
-	 * @param string $tag The tag that would link to the external asset.
 	 * @param string $handle The registered handle of the script in question.
-	 * @param string $href The url of the asset in question.
 	 */
 	public static function set_suffix_on_min( $src, $handle ) {
 		if ( false === strpos( $src, '.min.css' ) ) {
@@ -6198,8 +6226,8 @@ 
 	 *  - Absolute URLs             `http://domain.com/feh.png`
 	 *  - Domain root relative URLs `/feh.png`
 	 *
-	 * @param $css string: The raw CSS -- should be read in directly from the file.
-	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
+	 * @param string $css string: The raw CSS -- should be read in directly from the file.
+	 * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
 	 *
 	 * @return mixed|string
 	 */
@@ -6490,7 +6518,7 @@ 
 	 *
 	 * @param string $option_name
 	 *
-	 * @return bool
+	 * @return false|null
 	 */
 	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
 		// Bail if Jump Start has already been dismissed
@@ -6578,7 +6606,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {

json-endpoints/class.wpcom-json-api-update-term-endpoint.php

Doc Comments +17 added lines

@@ -115,6 +115,11 @@ 
 	}
 
 	// /sites/%s/taxonomies/%s/terms/new -> $blog_id, $taxonomy
+
+	/**
+	 * @param string $path
+	 * @param string $taxonomy
+	 */
 	function new_term( $path, $blog_id, $taxonomy ) {
 		$args = $this->query_args();
 		$input = $this->input();
@@ -160,6 +165,12 @@ 
 	}
 
 	// /sites/%s/taxonomies/%s/terms/slug:%s -> $blog_id, $taxonomy, $slug
+
+	/**
+	 * @param string $path
+	 * @param string $slug
+	 * @param string $taxonomy
+	 */
 	function update_term( $path, $blog_id, $slug, $taxonomy ) {
 		$tax = get_taxonomy( $taxonomy );
 		if ( ! current_user_can( $tax->cap->edit_terms ) ) {
@@ -208,6 +219,12 @@ 
 	}
 
 	// /sites/%s/taxonomies/%s/terms/slug:%s/delete -> $blog_id, $taxonomy, $slug
+
+	/**
+	 * @param string $path
+	 * @param string $slug
+	 * @param string $taxonomy
+	 */
 	function delete_term( $path, $blog_id, $slug, $taxonomy ) {
 		$term = get_term_by( 'slug', $slug, $taxonomy );
 		$tax = get_taxonomy( $taxonomy );