Automattic / jetpack

class.jetpack-signature.php

Doc Comments +3 added lines

@@ -183,6 +183,9 @@
 	}
 }
 
+/**
+ * @param string $text
+ */
 function jetpack_sha1_base64( $text ) {
 	return base64_encode( sha1( $text, true ) );
 }

class.jetpack-sync.php

Doc Comments +9 added lines, -3 removed lines

@@ -65,7 +65,6 @@ 
 
 	/**
 	 * @param string $file __FILE__
-	 * @param string $option, Option name to sync
 	 * @param string $option ...
 	 */
 	static function sync_options( $file, $option /*, $option, ... */ ) {
@@ -76,8 +75,6 @@ 
 	}
 	/**
 	 * @param string $file __FILE__
-	 * @param string $option, Option name to sync
-	 * @param string $option ...
 	 */
 	static function sync_constant( $file, $constant ) {
 		if ( is_network_admin() ) return;
@@ -353,6 +350,9 @@ 
 		$this->transition_post_status_action( 'delete', $post->post_status, $post );
 	}
 
+	/**
+	 * @param string $new_status
+	 */
 	function transition_post_status_action( $new_status, $old_status, $post ) {
 		$sync = $this->get_post_sync_operation( $new_status, $old_status, $post, $this->sync_conditions['posts'] );
 		if ( !$sync ) {
@@ -737,6 +737,11 @@ 
 /* Options Sync */
 
 	/* Ah... so much simpler than Posts and Comments :) */
+
+	/**
+	 * @param string $file
+	 * @param string $option
+	 */
 	function options( $file, $option /*, $option, ... */ ) {
 		$options = func_get_args();
 		$file = array_shift( $options );
@@ -844,6 +849,7 @@ 
 
 	/**
 	 * Returns default values of Constants
+	 * @param string $constant
 	 */
 	function default_constant( $constant ) {
 		switch( $constant ) {

class.jetpack-xmlrpc-server.php

Doc Comments +2 added lines, -1 removed lines

@@ -148,6 +148,7 @@ 
 	/**
 	 * Returns the current error as an IXR_Error
 	 *
+	 * @param Jetpack_Error $error
 	 * @return null|IXR_Error
 	 */
 	function error( $error = null ) {
@@ -174,7 +175,7 @@ 
 	/**
 	 * Just authenticates with the given Jetpack credentials.
 	 *
-	 * @return bool|IXR_Error
+	 * @return string
 	 */
 	function test_connection() {
 		return JETPACK__VERSION;

class.jetpack.php

Doc Comments +43 added lines, -9 removed lines

@@ -1053,7 +1053,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' );
@@ -1101,7 +1101,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 ''
@@ -1112,7 +1112,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();
@@ -1210,7 +1210,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' ) ) {
@@ -1972,7 +1972,7 @@ 
 	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
  	 *
 	 * @param string $name    Option name
-	 * @param mixed  $default (optional)
+	 * @param boolean  $default (optional)
 	 */
 	public static function get_option( $name, $default = false ) {
 		return Jetpack_Options::get_option( $name, $default );
@@ -1982,6 +1982,7 @@ 
 	* Stores two secrets and a timestamp so WordPress.com can make a request back and verify an action
 	* Does some extra verification so urls (such as those to public-api, register, etc) can't just be crafted
 	* $name must be a registered option name.
+	* @param string $name
 	*/
 	public static function create_nonce( $name ) {
 		$secret = wp_generate_password( 32, false ) . ':' . wp_generate_password( 32, false ) . ':' . ( time() + 600 );
@@ -2039,6 +2040,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
@@ -2433,6 +2435,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
@@ -2456,6 +2459,9 @@ 
 		return $data;
 	}
 
+	/**
+	 * @param string $untranslated_tag
+	 */
 	public static function translate_module_tag( $untranslated_tag ) {
 		// Tags are aggregated by tools/build-module-headings-translations.php
 		// and output in modules/module-headings.php
@@ -2748,6 +2754,9 @@ 
 		$this->sync->sync_all_module_options( $module );
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function deactivate_module( $module ) {
 		/**
 		 * Fires when a module is deactivated.
@@ -2786,6 +2795,9 @@ 
 		return Jetpack_Options::update_option( 'active_modules', array_unique( $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' );
@@ -2796,21 +2808,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 );
@@ -2818,6 +2842,9 @@ 
 
 /* Installation */
 
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3431,7 +3458,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();
@@ -4721,6 +4748,7 @@ 
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -5146,6 +5174,10 @@ 
 		return new WP_User( $token_details['user_id'] );
 	}
 
+	/**
+	 * @param integer $timestamp
+	 * @param string $nonce
+	 */
 	function add_nonce( $timestamp, $nonce ) {
 		global $wpdb;
 		static $nonces_used_this_request = array();
@@ -5351,6 +5383,9 @@ 
 		Jetpack::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -6332,8 +6367,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
 	 */
@@ -6731,7 +6766,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {

class.json-api-endpoints.php

Doc Comments +6 added lines, -2 removed lines

@@ -1352,6 +1352,7 @@ 
 	 * timezone set in the options table for the blog or the GMT offset.
 	 *
 	 * @param datetime string
+	 * @param string $date_string
 	 *
 	 * @return array( $local_time_string, $gmt_time_string )
 	 */
@@ -1466,6 +1467,10 @@ 
 		do_action( 'restapi_theme_init' );
 	}
 
+	/**
+	 * @param string $from_hook
+	 * @param string $to_hook
+	 */
 	function copy_hooks( $from_hook, $to_hook, $base_paths ) {
 		global $wp_filter;
 		foreach ( $wp_filter as $hook => $actions ) {
@@ -1520,7 +1525,7 @@ 
 	 *
 	 * This method is used in get_link() to construct meta links for API responses.
 	 *
-	 * @param $path string The current endpoint path, relative to the version
+	 * @param string $path string The current endpoint path, relative to the version
 	 * @param $method string Request method used to access the endpoint path
 	 * @return string The current version, or otherwise the maximum version available
 	 */
@@ -1648,7 +1653,6 @@ 
 	 *
 	 * Used to construct meta links in API responses
 	 *
-	 * @param mixed $args Optional arguments to be appended to URL
 	 * @return string Endpoint URL
 	 **/
 	function get_link() {

class.json-api.php

Doc Comments +14 added lines

@@ -29,6 +29,9 @@ 
 	public $did_output = false;
 
 	/**
+	 * @param string $method
+	 * @param string $url
+	 * @param string $post_body
 	 * @return WPCOM_JSON_API instance
 	 */
 	static function init( $method = null, $url = null, $post_body = null ) {
@@ -342,6 +345,9 @@ 
 		return call_user_func_array( array( $endpoint, 'callback' ), $path_pieces );
 	}
 
+	/**
+	 * @param integer $status_code
+	 */
 	function output_early( $status_code, $response = null, $content_type = 'application/json' ) {
 		$exit = $this->exit;
 		$this->exit = false;
@@ -536,6 +542,9 @@ 
 		return json_encode( $data );
 	}
 
+	/**
+	 * @param string $needle
+	 */
 	function ends_with( $haystack, $needle ) {
 		return $needle === substr( $haystack, -strlen( $needle ) );
 	}
@@ -563,6 +572,10 @@ 
 	}
 
 	// Returns true if the specified blog ID is a restricted blog
+
+	/**
+	 * @param integer $blog_id
+	 */
 	function is_restricted_blog( $blog_id ) {
 		/**
 		 * Filters all REST API access and return a 403 unauthorized response for all Restricted blog IDs.
@@ -626,6 +639,7 @@ 
 	 * The result is always output, never returned.
 	 *
 	 * @param string|null $error_code.  Call with string to start the trapping.  Call with null to stop.
+	 * @param string $error_code
 	 */
 	function trap_wp_die( $error_code = null ) {
 		// Stop trapping

class.media-extractor.php

Doc Comments +1 added lines, -1 removed lines

@@ -74,7 +74,7 @@
 	 * NOTE: If you want IMAGES, call extract( $blog_id, $post_id, ...) which will give you more/better image extraction
 	 * This method will give you an error if you ask for IMAGES.
 	 *
-	 * @param $content The HTML post_content of a post
+	 * @param string $content The HTML post_content of a post
 	 * @param $what_to_extract (int) A mask of things to extract, e.g. Jetpack_Media_Meta_Extractor::IMAGES | Jetpack_Media_Meta_Extractor::MENTIONS
 	 * @param $already_extracted (array) Previously extracted things, e.g. images from extract(), which can be used for x-referencing here
 	 * @returns a structure containing metadata about the embedded things, or empty array if nothing found, or WP_Error on error

class.media-summary.php

Doc Comments +6 added lines

@@ -214,6 +214,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $type
+	 */
 	static function get_video_poster( $type, $id ) {
 		if ( 'videopress' == $type ) {
 			if ( function_exists( 'video_get_highest_resolution_image_url' ) ) {
@@ -267,6 +270,9 @@ 
 		return str_word_count( self::clean_text( $post_content ) );
 	}
 
+	/**
+	 * @param string $excerpt_content
+	 */
 	static function get_word_remaining_count( $post_content, $excerpt_content ) {
 		return str_word_count( self::clean_text( $post_content ) ) - str_word_count( self::clean_text( $excerpt_content ) );
 	}

functions.photon.php

Doc Comments +1 added lines

@@ -7,6 +7,7 @@
  *
  * @param string $image_url URL to the publicly accessible image you want to manipulate
  * @param array|string $args An array of arguments, i.e. array( 'w' => '300', 'resize' => array( 123, 456 ) ), or in string form (w=123&h=456)
+ * @param string $scheme
  * @return string The raw final URL. You should run this through esc_url() before displaying it.
  */
 function jetpack_photon_url( $image_url, $args = array(), $scheme = null ) {