Automattic / jetpack

class.jetpack-signature.php

Doc Comments +3 added lines

@@ -183,6 +183,9 @@
 	}
 }
 
+/**
+ * @param string $text
+ */
 function jetpack_sha1_base64( $text ) {
 	return base64_encode( sha1( $text, true ) );
 }

class.jetpack-sync.php

Doc Comments +9 added lines, -3 removed lines

@@ -65,7 +65,6 @@ 
 
 	/**
 	 * @param string $file __FILE__
-	 * @param string $option, Option name to sync
 	 * @param string $option ...
 	 */
 	static function sync_options( $file, $option /*, $option, ... */ ) {
@@ -76,8 +75,6 @@ 
 	}
 	/**
 	 * @param string $file __FILE__
-	 * @param string $option, Option name to sync
-	 * @param string $option ...
 	 */
 	static function sync_constant( $file, $constant ) {
 		if ( is_network_admin() ) return;
@@ -353,6 +350,9 @@ 
 		$this->transition_post_status_action( 'delete', $post->post_status, $post );
 	}
 
+	/**
+	 * @param string $new_status
+	 */
 	function transition_post_status_action( $new_status, $old_status, $post ) {
 		$sync = $this->get_post_sync_operation( $new_status, $old_status, $post, $this->sync_conditions['posts'] );
 		if ( !$sync ) {
@@ -737,6 +737,11 @@ 
 /* Options Sync */
 
 	/* Ah... so much simpler than Posts and Comments :) */
+
+	/**
+	 * @param string $file
+	 * @param string $option
+	 */
 	function options( $file, $option /*, $option, ... */ ) {
 		$options = func_get_args();
 		$file = array_shift( $options );
@@ -844,6 +849,7 @@ 
 
 	/**
 	 * Returns default values of Constants
+	 * @param string $constant
 	 */
 	function default_constant( $constant ) {
 		switch( $constant ) {

class.jetpack-xmlrpc-server.php

Doc Comments +2 added lines, -1 removed lines

@@ -148,6 +148,7 @@ 
 	/**
 	 * Returns the current error as an IXR_Error
 	 *
+	 * @param Jetpack_Error $error
 	 * @return null|IXR_Error
 	 */
 	function error( $error = null ) {
@@ -174,7 +175,7 @@ 
 	/**
 	 * Just authenticates with the given Jetpack credentials.
 	 *
-	 * @return bool|IXR_Error
+	 * @return string
 	 */
 	function test_connection() {
 		return JETPACK__VERSION;

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

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

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

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;