Automattic / jetpack

_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;