Automattic / jetpack

class.jetpack.php

Doc Comments +47 added lines, -14 removed lines

@@ -876,7 +876,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' );
@@ -976,7 +976,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 ''
@@ -987,7 +987,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();
@@ -1045,7 +1045,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' ) ) {
@@ -1629,6 +1629,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 );
@@ -1686,6 +1687,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
@@ -2080,6 +2082,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
@@ -2108,7 +2111,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 );
@@ -2121,7 +2124,7 @@ 
 	 *
 	 * @param array $modules
 	 *
-	 * @return string|void
+	 * @return string
 	 */
 	public static function get_translated_modules( $modules ) {
 		foreach ( $modules as $index => $module ) {
@@ -2409,6 +2412,9 @@ 
 		_deprecated_function( __METHOD__, 'jeptack-4.2' );
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function deactivate_module( $module ) {
 		/**
 		 * Fires when a module is deactivated.
@@ -2437,6 +2443,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' );
@@ -2447,21 +2456,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 );
@@ -2469,6 +2490,9 @@ 
 
 /* Installation */
 
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3097,7 +3121,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();
@@ -4122,6 +4146,7 @@ 
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -4266,7 +4291,8 @@ 
 	 * Note these tokens are unique per call, NOT static per site for connecting.
 	 *
 	 * @since 2.6
-	 * @return array
+	 * @param string $action
+	 * @return string
 	 */
 	public function generate_secrets( $action, $exp = 600 ) {
 	    $secret = wp_generate_password( 32, false ) // secret_1
@@ -4592,6 +4618,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();
@@ -4737,6 +4767,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();
@@ -4793,6 +4824,9 @@ 
 		Jetpack::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -5120,7 +5154,7 @@ 
 	/**
 	 * Pings the WordPress.com Mirror Site for the specified options.
 	 *
-	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
+	 * @param string[] $option_names The option names to request from the WordPress.com Mirror Site
 	 *
 	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
 	 */
@@ -5144,7 +5178,7 @@ 
 	/**
 	 * Fetch the filtered array of options that we should compare to determine an identity crisis.
 	 *
-	 * @return array An array of options to check.
+	 * @return string[] An array of options to check.
 	 */
 	public static function identity_crisis_options_to_check() {
 		return array(
@@ -5516,8 +5550,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
 	 */
@@ -5826,7 +5860,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
@@ -5917,7 +5951,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {

modules/wordads/php/admin.php

Doc Comments +1 added lines

@@ -141,6 +141,7 @@
 
 	/**
 	 * @since 0.1
+	 * @param string $key
 	 */
 	function get_option( $key, $default = null ) {
 		// Options are limited to those specified in $this->valid_settings

modules/wordads/wordads.php

Doc Comments +3 added lines, -3 removed lines

@@ -47,7 +47,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 0.1
@@ -304,7 +304,7 @@ 
 	/**
 	 * Enforce Jetpack activated. Otherwise, load special no-jetpack admin.
 	 *
-	 * @return true if Jetpack is active and activated
+	 * @return boolean if Jetpack is active and activated
 	 *
 	 * @since 0.1
 	 */
@@ -325,7 +325,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 0.1
 	 */