Automattic / jetpack

class.json-api-endpoints.php

Doc Comments +6 added lines, -2 removed lines

@@ -1352,6 +1352,7 @@ 
 	 * timezone set in the options table for the blog or the GMT offset.
 	 *
 	 * @param datetime string
+	 * @param string $date_string
 	 *
 	 * @return array( $local_time_string, $gmt_time_string )
 	 */
@@ -1466,6 +1467,10 @@ 
 		do_action( 'restapi_theme_init' );
 	}
 
+	/**
+	 * @param string $from_hook
+	 * @param string $to_hook
+	 */
 	function copy_hooks( $from_hook, $to_hook, $base_paths ) {
 		global $wp_filter;
 		foreach ( $wp_filter as $hook => $actions ) {
@@ -1520,7 +1525,7 @@ 
 	 *
 	 * This method is used in get_link() to construct meta links for API responses.
 	 *
-	 * @param $path string The current endpoint path, relative to the version
+	 * @param string $path string The current endpoint path, relative to the version
 	 * @param $method string Request method used to access the endpoint path
 	 * @return string The current version, or otherwise the maximum version available
 	 */
@@ -1648,7 +1653,6 @@ 
 	 *
 	 * Used to construct meta links in API responses
 	 *
-	 * @param mixed $args Optional arguments to be appended to URL
 	 * @return string Endpoint URL
 	 **/
 	function get_link() {

class.json-api.php

Doc Comments +14 added lines

@@ -29,6 +29,9 @@ 
 	public $did_output = false;
 
 	/**
+	 * @param string $method
+	 * @param string $url
+	 * @param string $post_body
 	 * @return WPCOM_JSON_API instance
 	 */
 	static function init( $method = null, $url = null, $post_body = null ) {
@@ -342,6 +345,9 @@ 
 		return call_user_func_array( array( $endpoint, 'callback' ), $path_pieces );
 	}
 
+	/**
+	 * @param integer $status_code
+	 */
 	function output_early( $status_code, $response = null, $content_type = 'application/json' ) {
 		$exit = $this->exit;
 		$this->exit = false;
@@ -536,6 +542,9 @@ 
 		return json_encode( $data );
 	}
 
+	/**
+	 * @param string $needle
+	 */
 	function ends_with( $haystack, $needle ) {
 		return $needle === substr( $haystack, -strlen( $needle ) );
 	}
@@ -563,6 +572,10 @@ 
 	}
 
 	// Returns true if the specified blog ID is a restricted blog
+
+	/**
+	 * @param integer $blog_id
+	 */
 	function is_restricted_blog( $blog_id ) {
 		/**
 		 * Filters all REST API access and return a 403 unauthorized response for all Restricted blog IDs.
@@ -626,6 +639,7 @@ 
 	 * The result is always output, never returned.
 	 *
 	 * @param string|null $error_code.  Call with string to start the trapping.  Call with null to stop.
+	 * @param string $error_code
 	 */
 	function trap_wp_die( $error_code = null ) {
 		// Stop trapping

functions.photon.php

Doc Comments +1 added lines

@@ -7,6 +7,7 @@
  *
  * @param string $image_url URL to the publicly accessible image you want to manipulate
  * @param array|string $args An array of arguments, i.e. array( 'w' => '300', 'resize' => array( 123, 456 ) ), or in string form (w=123&h=456)
+ * @param string $scheme
  * @return string The raw final URL. You should run this through esc_url() before displaying it.
  */
 function jetpack_photon_url( $image_url, $args = array(), $scheme = null ) {

json-endpoints/class.wpcom-json-api-list-posts-v1-1-endpoint.php

Doc Comments +3 added lines

@@ -328,6 +328,9 @@
 		return build_query( array( 'value' => urlencode($post[$column]), 'id' => $post['ID'] ) );
 	}
 
+	/**
+	 * @param string $column
+	 */
 	function _build_date_range_query( $column, $range, $where ) {
 		global $wpdb;
 

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

Doc Comments +3 added lines

@@ -297,6 +297,7 @@ 
 	 * @param array $items item tree
 	 * @param array &$items_list output flat list of items
 	 * @param int &$counter for creating temporary IDs
+	 * @param integer $counter
 	 */
 	protected function untreeify_items( $items, &$items_list, &$counter ) {
 		foreach( $items as $index => $item ) {
@@ -546,6 +547,7 @@ 
 	 * This function will create items that have a 'tmp_id' set, and
 	 * update any items with a 'tmp_parent' to use the
 	 * newly created item as a parent.
+	 * @param integer $menu_id
 	 */
 	function create_new_items( $data, $menu_id ) {
 		$tmp_to_actual_ids = array();
@@ -571,6 +573,7 @@ 
 	/**
 	 * remove any existing menu items not present in the supplied array.
 	 * returns wp_error if an item cannot be deleted.
+	 * @param integer $menu_id
 	 */
 	function delete_items_not_present( $menu_id, $menu_items ) {
 

json-endpoints/class.wpcom-json-api-publicize-endpoint.php

Doc Comments +4 added lines

@@ -45,6 +45,10 @@
 }
 
 class WPCOM_JSON_API_Get_Connection_Endpoint extends WPCOM_JSON_API_Endpoint {
+
+	/**
+	 * @param integer $connection_id
+	 */
 	function get_connection_by_id( $connection_id ) {
 		$publicize = new Publicize();
 

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

Doc Comments +1 added lines

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

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

Doc Comments +16 added lines

@@ -35,6 +35,12 @@ 
 
 	// /sites/%s/posts/%d/replies/new    -> $blog_id, $post_id
 	// /sites/%s/comments/%d/replies/new -> $blog_id, $comment_id
+
+	/**
+	 * @param string $path
+	 * @param integer $post_id
+	 * @param integer $comment_parent_id
+	 */
 	function new_comment( $path, $blog_id, $post_id, $comment_parent_id ) {
 		if ( !$post_id ) {
 			$comment_parent = get_comment( $comment_parent_id );
@@ -146,6 +152,11 @@ 
 	}
 
 	// /sites/%s/comments/%d -> $blog_id, $comment_id
+
+	/**
+	 * @param string $path
+	 * @param integer $comment_id
+	 */
 	function update_comment( $path, $blog_id, $comment_id ) {
 		$comment = get_comment( $comment_id );
 		if ( !$comment || is_wp_error( $comment ) ) {
@@ -235,6 +246,11 @@ 
 	}
 
 	// /sites/%s/comments/%d/delete -> $blog_id, $comment_id
+
+	/**
+	 * @param string $path
+	 * @param integer $comment_id
+	 */
 	function delete_comment( $path, $blog_id, $comment_id ) {
 		$comment = get_comment( $comment_id );
 		if ( !$comment || is_wp_error( $comment ) ) {

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