Automattic / jetpack

modules/publicize/publicize.php

Doc Comments +1 added lines

@@ -246,6 +246,7 @@
 
 	/**
 	* Returns true if a user has a connection to a particular service, false otherwise
+	* @param string $service
 	*/
 	function is_enabled( $service, $_blog_id = false, $_user_id = false ) {
 		if ( !$_blog_id )

class.jetpack.php

Doc Comments +42 added lines, -9 removed lines

@@ -1074,7 +1074,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' );
@@ -1122,7 +1122,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 ''
@@ -1133,7 +1133,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();
@@ -1231,7 +1231,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' ) ) {
@@ -2027,7 +2027,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 );
@@ -2094,6 +2094,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
@@ -2488,6 +2489,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
@@ -2511,6 +2513,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
@@ -2803,6 +2808,9 @@ 
 		$this->sync->sync_all_module_options( $module );
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function deactivate_module( $module ) {
 		/**
 		 * Fires when a module is deactivated.
@@ -2841,6 +2849,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' );
@@ -2851,21 +2862,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 );
@@ -2873,6 +2896,9 @@ 
 
 /* Installation */
 
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3486,7 +3512,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();
@@ -4776,6 +4802,7 @@ 
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -5201,6 +5228,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();
@@ -5406,6 +5437,9 @@ 
 		Jetpack::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -6387,8 +6421,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
 	 */
@@ -6786,7 +6820,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {

modules/publicize/publicize-jetpack.php

Doc Comments +6 added lines

@@ -75,6 +75,9 @@ 
 		) );
 	}
 
+	/**
+	 * @param string $service_name
+	 */
 	function get_connections( $service_name, $_blog_id = false, $_user_id = false ) {
 		$connections = Jetpack_Options::get_option( 'publicize_connections' );
 		$connections_to_return = array();
@@ -100,6 +103,9 @@ 
 		return $connection;
 	}
 
+	/**
+	 * @param string $filter
+	 */
 	function get_services( $filter ) {
 		if ( !in_array( $filter, array( 'all', 'connected' ) ) )
 			$filter = 'all';

_inc/lib/tracks/class.tracks-client.php

Doc Comments +2 added lines, -1 removed lines

@@ -49,7 +49,7 @@ 
 
 	/**
 	 * record_event
-	 * @param  mixed  $event Event object to send to Tracks. An array will be cast to object. Required.
+	 * @param  Tracks_Event  $event Event object to send to Tracks. An array will be cast to object. Required.
 	 *                       Properties are included directly in the pixel query string after light validation.
 	 * @return mixed         True on success, WP_Error on failure
 	 */
@@ -74,6 +74,7 @@ 
 
 	/**
 	 * Synchronously request the pixel
+	 * @param string $pixel
 	 */
 	static function record_pixel( $pixel ) {
 		// Add the Request Timestamp and URL terminator just before the HTTP request.

_inc/lib/tracks/client.php

Doc Comments +1 added lines, -2 removed lines

@@ -37,7 +37,7 @@ 
  * @param string $event_name The name of the event
  * @param array $properties Custom properties to send with the event
  * @param int $event_timestamp_millis The time in millis since 1970-01-01 00:00:00 when the event occurred
- * @return \Tracks_Event|\WP_Error
+ * @return Tracks_Event
  */
 function tracks_build_event_obj( $user
 								, $event_name
@@ -78,7 +78,6 @@ 
 /**
  * Record an event in Tracks - this is the preferred way to record events from PHP.
  *
- * @param mixed $identity username, user_id, or WP_user object
  * @param string $event_name The name of the event
  * @param array $properties Custom properties to send with the event
  * @param int $event_timestamp_millis The time in millis since 1970-01-01 00:00:00 when the event occurred

class.jetpack-tracks.php

Doc Comments +3 added lines

@@ -24,6 +24,9 @@
 		self::record_user_event( 'module_deactivated', array( 'module' => $module ) );
 	}
 
+	/**
+	 * @param string $event_type
+	 */
 	static function record_user_event( $event_type, $data ) {
 
 		$user = wp_get_current_user();

modules/shortcodes/gist.php

Doc Comments +3 added lines

@@ -51,6 +51,9 @@
 	return  $return;
 }
 
+/**
+ * @param string $file
+ */
 function github_gist_simple_embed( $id, $file ) {
 	$embed_url = $id . '.js' . $file;