Automattic / jetpack

class.jetpack-sync.php

Doc Comments +8 added lines, -3 removed lines

@@ -64,7 +64,6 @@ 
 
 	/**
 	 * @param string $file __FILE__
-	 * @param string $option, Option name to sync
 	 * @param string $option ...
 	 */
 	static function sync_options( $file, $option /*, $option, ... */ ) {
@@ -75,8 +74,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;
@@ -352,6 +349,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 ) {
@@ -736,6 +736,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 );

class.jetpack.php

Doc Comments +38 added lines, -7 removed lines

@@ -881,7 +881,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 ''
@@ -892,7 +892,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();
@@ -1452,7 +1452,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 );
@@ -1462,6 +1462,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 );
@@ -1519,6 +1520,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
@@ -1895,6 +1897,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
@@ -1918,6 +1921,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
@@ -2167,6 +2173,9 @@ 
 		$this->sync->sync_all_module_options( $module );
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function deactivate_module( $module ) {
 		do_action( 'jetpack_pre_deactivate_module', $module );
 
@@ -2190,6 +2199,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' );
@@ -2200,16 +2212,25 @@ 
 		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 );
@@ -2217,6 +2238,9 @@ 
 
 /* Installation */
 
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -2782,7 +2806,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();
@@ -4008,6 +4032,7 @@ 
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -4422,6 +4447,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();
@@ -4627,6 +4656,9 @@ 
 		Jetpack::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -5272,8 +5304,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
 	 */
@@ -5661,7 +5693,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-post-endpoint.php

Doc Comments +18 added lines

@@ -28,6 +28,11 @@ 
 
 	// /sites/%s/posts/new       -> $blog_id
 	// /sites/%s/posts/%d        -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 * @param integer $post_id
+	 */
 	function write_post( $path, $blog_id, $post_id ) {
 		$new  = $this->api->ends_with( $path, '/new' );
 		$args = $this->query_args();
@@ -578,6 +583,11 @@ 
 	}
 
 	// /sites/%s/posts/%d/delete -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 * @param integer $post_id
+	 */
 	function delete_post( $path, $blog_id, $post_id ) {
 		$post = get_post( $post_id );
 		if ( !$post || is_wp_error( $post ) ) {
@@ -612,6 +622,11 @@ 
 	}
 
 	// /sites/%s/posts/%d/restore -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 * @param integer $post_id
+	 */
 	function restore_post( $path, $blog_id, $post_id ) {
 		$args  = $this->query_args();
 		$post = get_post( $post_id );
@@ -631,6 +646,9 @@ 
 		return $this->get_post_by( 'ID', $post->ID, $args['context'] );
 	}
 
+	/**
+	 * @param boolean $delete_featured_image
+	 */
 	private function parse_and_set_featured_image( $post_id, $delete_featured_image, $featured_image ) {
 		if ( $delete_featured_image ) {
 			delete_post_thumbnail( $post_id );

json-endpoints/jetpack/class.jetpack-json-api-endpoint.php

Doc Comments +1 added lines

@@ -56,6 +56,7 @@
 
 	/**
 	 * Switches to the blog and checks current user capabilities.
+	 * @param integer $_blog_id
 	 * @return bool|WP_Error a WP_Error object or true if things are good.
 	 */
 	protected function validate_call( $_blog_id, $capability, $check_manage_active = true ) {

locales.php

Doc Comments +6 added lines

@@ -42,6 +42,9 @@ 
 		return $numbers;
 	}
 
+	/**
+	 * @param integer $number
+	 */
 	public function index_for_number( $number ) {
 		if ( !isset( $this->_index_for_number ) ) {
 			$gettext = new Gettext_Translations;
@@ -2014,6 +2017,9 @@ 
 		return isset( $instance->locales[ $slug ] )? $instance->locales[ $slug ] : null;
 	}
 
+	/**
+	 * @param string $field_name
+	 */
 	public static function by_field( $field_name, $field_value ) {
 		$instance = GP_Locales::instance();
 		$result   = false;

modules/contact-form/grunion-contact-form.php

Doc Comments +4 added lines, -2 removed lines

@@ -1004,7 +1004,6 @@ 
 	 * Turn on printing of grunion.css stylesheet
 	 * @see ::style()
 	 * @internal
-	 * @param bool $style
 	 */
 	static function _style_on() {
 		return self::style( true );
@@ -1116,6 +1115,9 @@ 
 		return $r;
 	}
 
+	/**
+	 * @param Grunion_Contact_Form $form
+	 */
 	static function success_message( $feedback_id, $form ) {
 		$r_success_message = '';
 
@@ -1192,7 +1194,7 @@ 
 	 *
 	 * @param array $attributes Key => Value pairs as parsed by shortcode_parse_atts()
 	 * @param string|null $content The shortcode's inner content: [contact-field]$content[/contact-field]
-	 * @return HTML for the contact form field
+	 * @return string for the contact form field
 	 */
 	static function parse_contact_field( $attributes, $content ) {
 		// Don't try to parse contact form fields if not inside a contact form

modules/sharedaddy/sharing-sources.php

Doc Comments +6 added lines

@@ -172,6 +172,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;
@@ -1122,6 +1125,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 ) );