Automattic / jetpack

modules/custom-post-types/portfolios.php

Doc Comments +5 added lines, -4 removed lines

@@ -488,7 +488,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
@@ -621,7 +621,7 @@ 
 	 * The Portfolio shortcode loop.
 	 *
 	 * @todo add theme color styles
-	 * @return html
+	 * @return string
 	 */
 	static function portfolio_shortcode_html( $atts ) {
 
@@ -713,6 +713,7 @@ 
 	/**
 	 * Individual project class
 	 *
+	 * @param integer $portfolio_index_number
 	 * @return string
 	 */
 	static function get_project_class( $portfolio_index_number, $columns ) {
@@ -820,7 +821,7 @@ 
 	/**
 	 * Displays the author of the current portfolio project.
 	 *
-	 * @return html
+	 * @return string
 	 */
 	static function get_project_author() {
 		$html = '<div class="project-author">';
@@ -837,7 +838,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 ) ) {

modules/custom-post-types/testimonial.php

Doc Comments +4 added lines, -3 removed lines

@@ -525,7 +525,7 @@ 
 	 * Our [testimonial] shortcode.
 	 * Prints Testimonial data styled to look good on *any* theme.
 	 *
-	 * @return jetpack_testimonial_shortcode_html
+	 * @return string
 	 */
 	static function jetpack_testimonial_shortcode( $atts ) {
 		// Default attributes
@@ -588,7 +588,7 @@ 
 	/**
 	 * The Testimonial shortcode loop.
 	 *
-	 * @return html
+	 * @return string
 	 */
 	static function jetpack_testimonial_shortcode_html( $atts ) {
 		// Default query arguments
@@ -662,6 +662,7 @@ 
 	/**
 	 * Individual testimonial class
 	 *
+	 * @param integer $testimonial_index_number
 	 * @return string
 	 */
 	static function get_testimonial_class( $testimonial_index_number, $columns, $image ) {
@@ -708,7 +709,7 @@ 
 	/**
 	 * Display the featured image if it's available
 	 *
-	 * @return html
+	 * @return string|null
 	 */
 	static function get_testimonial_thumbnail_link( $post_id ) {
 		if ( has_post_thumbnail( $post_id ) ) {

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

Doc Comments +3 added lines

@@ -170,6 +170,9 @@
 	}
 
 
+	/**
+	 * @param string $plugin
+	 */
 	protected function validate_plugin( $plugin ) {
 		if ( ! isset( $plugin) || empty( $plugin ) ) {
 			return new WP_Error( 'missing_plugin', __( 'You are required to specify a plugin to activate.', 'jetpack' ), 400 );

class.jetpack-post-images.php

Doc Comments +1 added lines, -1 removed lines

@@ -153,6 +153,7 @@ 
 	/**
 	 * Get attachment images for a specified post and return them. Also make sure
 	 * their dimensions are at or above a required minimum.
+	 * @param integer $post_id
 	 */
 	static function from_attachment( $post_id, $width = 200, $height = 200 ) {
 		$images = array();
@@ -545,7 +546,6 @@ 
 	 * resized and cropped image.
 	 *
 	 * @param  string $src
-	 * @param  int    $dimension
 	 * @return string            Transformed image URL
 	 */
 	static function fit_image_url( $src, $width, $height ) {

3rd-party/qtranslate-x.php

Doc Comments +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
  * @param string $url_orig Original URL.
  * @param array $url_info  Pieces of original URL.
  *
- * @return bool
+ * @return false|string
  */
 function jetpack_no_qtranslate_rest_url_redirect( $url_lang, $url_orig, $url_info ) {
 	if ( false !== strpos( $url_info['wp-path'], 'wp-json/jetpack' ) ) {

json-endpoints/class.wpcom-json-api-site-user-endpoint.php

Doc Comments +1 added lines

@@ -63,6 +63,7 @@
 	/**
 	 * Updates user data
 	 *
+	 * @param integer $user_id
 	 * @return array
 	 */
 	public function update_user( $user_id, $blog_id ) {

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

Doc Comments +17 added lines

@@ -115,6 +115,11 @@ 
 	}
 
 	// /sites/%s/taxonomies/%s/terms/new -> $blog_id, $taxonomy
+
+	/**
+	 * @param string $path
+	 * @param string $taxonomy
+	 */
 	function new_term( $path, $blog_id, $taxonomy ) {
 		$args = $this->query_args();
 		$input = $this->input();
@@ -160,6 +165,12 @@ 
 	}
 
 	// /sites/%s/taxonomies/%s/terms/slug:%s -> $blog_id, $taxonomy, $slug
+
+	/**
+	 * @param string $path
+	 * @param string $slug
+	 * @param string $taxonomy
+	 */
 	function update_term( $path, $blog_id, $slug, $taxonomy ) {
 		$tax = get_taxonomy( $taxonomy );
 		if ( ! current_user_can( $tax->cap->edit_terms ) ) {
@@ -208,6 +219,12 @@ 
 	}
 
 	// /sites/%s/taxonomies/%s/terms/slug:%s/delete -> $blog_id, $taxonomy, $slug
+
+	/**
+	 * @param string $path
+	 * @param string $slug
+	 * @param string $taxonomy
+	 */
 	function delete_term( $path, $blog_id, $slug, $taxonomy ) {
 		$term = get_term_by( 'slug', $slug, $taxonomy );
 		$tax = get_taxonomy( $taxonomy );

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

Doc Comments +17 added lines

@@ -214,6 +214,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 ) {
 		global $wpdb;
 
@@ -890,6 +895,10 @@ 
 	}
 
 	// /sites/%s/posts/%d/delete -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 */
 	function delete_post( $path, $blog_id, $post_id ) {
 		$post = get_post( $post_id );
 		if ( !$post || is_wp_error( $post ) ) {
@@ -929,6 +938,10 @@ 
 	}
 
 	// /sites/%s/posts/%d/restore -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 */
 	function restore_post( $path, $blog_id, $post_id ) {
 		$args  = $this->query_args();
 		$post = get_post( $post_id );
@@ -949,6 +962,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/google-analytics/classes/wp-google-analytics-options.php

Doc Comments +4 added lines

@@ -15,6 +15,10 @@
 }
 
 class Jetpack_Google_Analytics_Options {
+
+	/**
+	 * @param string $option_name
+	 */
 	public static function get_option( $option_name, $default = false ) {
 		$o = get_option( 'jetpack_wga' );
 		return isset( $o[ $option_name ] ) ? $o[ $option_name ] : $default;