Automattic / jetpack

modules/custom-post-types/portfolios.php

Doc Comments +5 added lines, -4 removed lines

@@ -393,7 +393,7 @@ 
 	 * Our [portfolio] shortcode.
 	 * Prints Portfolio data styled to look good on *any* theme.
 	 *
-	 * @return portfolio_shortcode_html
+	 * @return string
 	 */
 	static function portfolio_shortcode( $atts ) {
 		// Default attributes
@@ -526,7 +526,7 @@ 
 	 * The Portfolio shortcode loop.
 	 *
 	 * @todo add theme color styles
-	 * @return html
+	 * @return string
 	 */
 	static function portfolio_shortcode_html( $atts ) {
 
@@ -618,6 +618,7 @@ 
 	/**
 	 * Individual project class
 	 *
+	 * @param integer $portfolio_index_number
 	 * @return string
 	 */
 	static function get_project_class( $portfolio_index_number, $columns ) {
@@ -725,7 +726,7 @@ 
 	/**
 	 * Displays the author of the current portfolio project.
 	 *
-	 * @return html
+	 * @return string
 	 */
 	static function get_project_author() {
 		$html = '<div class="project-author"><span>' . esc_html__( 'Author:', 'jetpack' ) . '</span> ';
@@ -738,7 +739,7 @@ 
 	/**
 	 * Display the featured image if it's available
 	 *
-	 * @return html
+	 * @return string|null
 	 */
 	static function get_portfolio_thumbnail_link( $post_id ) {
 		if ( has_post_thumbnail( $post_id ) ) {

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;
 

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

Doc Comments +2 added lines, -1 removed lines

@@ -48,7 +48,7 @@ 
 
 	/**
 	 * record_event
-	 * @param  mixed  $event Event object to send to Tracks. An array will be cast to object. Required.
+	 * @param  Jetpack_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
 	 */
@@ -71,6 +71,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 \Jetpack_Tracks_Event|\WP_Error
+ * @return Jetpack_Tracks_Event
  */
 function jetpack_tracks_build_event_obj( $user, $event_name, $properties = array(), $event_timestamp_millis = false ) {
 
@@ -107,7 +107,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