Automattic / jetpack

modules/videopress/class.videopress-video.php

Doc Comments +1 added lines, -1 removed lines

@@ -271,7 +271,7 @@
 	 *
 	 * @since 1.2
 	 * @param string $url absolute URL
-	 * @return bool|string host component of the URL, or false if none found
+	 * @return string|false host component of the URL, or false if none found
 	 */
 	public static function hostname( $url ) {
 		return parse_url( esc_url_raw( $url ), PHP_URL_HOST );

modules/videopress/videopress.php

Doc Comments +2 added lines

@@ -147,6 +147,7 @@ 
 	 * Performs a remote XML-RPC query using Jetpack's IXR Client. And also
 	 * appends some useful stuff about this setup to the query.
 	 *
+	 * @param string $method
 	 * @return the Jetpack_IXR_Client object after querying.
 	 */
 	function query( $method, $args = null ) {
@@ -349,6 +350,7 @@ 
 	 *
 	 * Similar to current_user_can, but internal to VideoPress. Returns
 	 * true if the given VideoPress capability is allowed by the given user.
+	 * @param string $cap
 	 */
 	function can( $cap, $user_id = false ) {
 		if ( ! $user_id )

modules/widgets/facebook-likebox.php

Doc Comments +3 added lines

@@ -252,6 +252,9 @@
 		return ( FALSE !== strpos( $url, 'facebook.com' ) ) ? TRUE : FALSE;
 	}
 
+	/**
+	 * @param integer $value
+	 */
 	function normalize_int_value( $value, $default = 0, $max = 0, $min = 0 ) {
 		$value = (int) $value;
 

modules/widgets/goodreads.php

Doc Comments +3 added lines

@@ -89,6 +89,9 @@
 		do_action( 'jetpack_stats_extra', 'widget', 'goodreads' );
 	}
 
+	/**
+	 * @param string $user_id
+	 */
 	function goodreads_user_id_exists( $user_id ) {
 		$url = "http://www.goodreads.com/user/show/$user_id/";
 		$response = wp_remote_head( $url, array( 'httpversion'=>'1.1', 'timeout'=>3, 'redirection'=> 2 ) );

json-endpoints/class.wpcom-json-api-update-post-endpoint.php

Doc Comments +19 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();
@@ -621,6 +626,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 ) ) {
@@ -656,6 +666,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 );
@@ -676,6 +691,10 @@ 
 		return $this->get_post_by( 'ID', $post->ID, $args['context'] );
 	}
 
+	/**
+	 * @param boolean $delete_featured_image
+	 * @param string $featured_image
+	 */
 	protected function parse_and_set_featured_image( $post_id, $delete_featured_image, $featured_image ) {
 		if ( $delete_featured_image ) {
 			delete_post_thumbnail( $post_id );

modules/widget-visibility/widget-conditions.php

Doc Comments +3 added lines

@@ -616,6 +616,9 @@
 		return strcasecmp( $a->name, $b->name );
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function maybe_get_split_term( $old_term_id = '', $taxonomy = '' ) {
 		$term_id = $old_term_id;
 

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 ) ) {

_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/class.media-extractor.php

Doc Comments +1 added lines, -1 removed lines

@@ -74,7 +74,7 @@
 	 * NOTE: If you want IMAGES, call extract( $blog_id, $post_id, ...) which will give you more/better image extraction
 	 * This method will give you an error if you ask for IMAGES.
 	 *
-	 * @param $content The HTML post_content of a post
+	 * @param string $content The HTML post_content of a post
 	 * @param $what_to_extract (int) A mask of things to extract, e.g. Jetpack_Media_Meta_Extractor::IMAGES | Jetpack_Media_Meta_Extractor::MENTIONS
 	 * @param $already_extracted (array) Previously extracted things, e.g. images from extract(), which can be used for x-referencing here
 	 * @returns a structure containing metadata about the embedded things, or empty array if nothing found, or WP_Error on error