Automattic / jetpack

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();
@@ -610,6 +615,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 ) ) {
@@ -645,6 +655,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 );
@@ -665,6 +680,10 @@ 
 		return $this->get_post_by( 'ID', $post->ID, $args['context'] );
 	}
 
+	/**
+	 * @param boolean $delete_featured_image
+	 * @param string $featured_image
+	 */
 	private function parse_and_set_featured_image( $post_id, $delete_featured_image, $featured_image ) {
 		if ( $delete_featured_image ) {
 			delete_post_thumbnail( $post_id );

json-endpoints/class.wpcom-json-api-update-post-v1-1-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 );

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

Doc Comments +17 added lines

@@ -26,6 +26,11 @@ 
 	}
 
 	// /sites/%s/tags|categories/new    -> $blog_id
+
+	/**
+	 * @param string $path
+	 * @param string $taxonomy_type
+	 */
 	function new_taxonomy( $path, $blog_id, $taxonomy_type ) {
 		$args  = $this->query_args();
 		$input = $this->input();
@@ -77,6 +82,12 @@ 
 	}
 
 	// /sites/%s/tags|categories/slug:%s -> $blog_id, $taxonomy_id
+
+	/**
+	 * @param string $path
+	 * @param integer $object_id
+	 * @param string $taxonomy_type
+	 */
 	function update_taxonomy( $path, $blog_id, $object_id, $taxonomy_type ) {
 		$taxonomy = get_term_by( 'slug', $object_id, $taxonomy_type );
 		$tax      = get_taxonomy( $taxonomy_type );
@@ -122,6 +133,12 @@ 
 	}
 
 	// /sites/%s/tags|categories/%s/delete -> $blog_id, $taxonomy_id
+
+	/**
+	 * @param string $path
+	 * @param integer $object_id
+	 * @param string $taxonomy_type
+	 */
 	function delete_taxonomy( $path, $blog_id, $object_id, $taxonomy_type ) {
 		$taxonomy = get_term_by( 'slug', $object_id, $taxonomy_type );
 		$tax      = get_taxonomy( $taxonomy_type );

modules/after-the-deadline/config-options.php

Doc Comments +9 added lines

@@ -6,6 +6,9 @@ 
 /*
  *   A convienence function to display the HTML for an AtD option
  */
+/**
+ * @param string $name
+ */
 function AtD_print_option( $name, $value, $options ) {
 	// Attribute-safe version of $name
 	$attr_name = sanitize_title($name); // Using sanitize_title since there's no comparable function for attributes
@@ -99,6 +102,9 @@ 
 /*
  *  Returns an array of AtD user options specified by $name
  */
+/**
+ * @param string $name
+ */
 function AtD_get_options( $user_id, $name ) {
 	$options_raw = AtD_get_setting( $user_id, $name, 'single' );
 
@@ -115,6 +121,9 @@ 
 /*
  *  Saves set of user options specified by $name from POST data
  */
+/**
+ * @param string $name
+ */
 function AtD_update_options( $user_id, $name ) {
 	/* We should probably run $_POST[name] through an esc_*() function... */
 	if ( isset( $_POST[$name] ) && is_array( $_POST[$name] ) ) {

modules/after-the-deadline/proxy.php

Doc Comments +1 added lines

@@ -6,6 +6,7 @@
 /**
  * Returns array with headers in $response[0] and body in $response[1]
  * Based on a function from Akismet
+ * @param string $request
  */
 function AtD_http_post( $request, $host, $path, $port = 80 ) {
 	$http_args = array(

modules/carousel/jetpack-carousel.php

Doc Comments +9 added lines

@@ -92,6 +92,9 @@ 
 		exit;
 	}
 
+	/**
+	 * @param string $version
+	 */
 	function asset_version( $version ) {
 		/**
 		 * Filter the version string used when enqueuing Carousel assets.
@@ -542,6 +545,9 @@ 
 		return ( 1 == $value ) ? 1 : 0;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function settings_checkbox($name, $label_text, $extra_text = '', $default_to_checked = true) {
 		if ( empty( $name ) )
 			return;
@@ -555,6 +561,9 @@ 
 		echo '</fieldset>';
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function settings_select($name, $values, $extra_text = '') {
 		if ( empty( $name ) || ! is_array( $values ) || empty( $values ) )
 			return;

_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

_inc/lib/class.media-summary.php

Doc Comments +6 added lines

@@ -214,6 +214,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $type
+	 */
 	static function get_video_poster( $type, $id ) {
 		if ( 'videopress' == $type ) {
 			if ( function_exists( 'video_get_highest_resolution_image_url' ) ) {
@@ -267,6 +270,9 @@ 
 		return str_word_count( self::clean_text( $post_content ) );
 	}
 
+	/**
+	 * @param string $excerpt_content
+	 */
 	static function get_word_remaining_count( $post_content, $excerpt_content ) {
 		return str_word_count( self::clean_text( $post_content ) ) - str_word_count( self::clean_text( $excerpt_content ) );
 	}