Automattic / jetpack

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

class.jetpack-xmlrpc-server.php

Doc Comments +1 added lines, -1 removed lines

@@ -196,7 +196,7 @@
 	/**
 	 * Just authenticates with the given Jetpack credentials.
 	 *
-	 * @return bool|IXR_Error
+	 * @return string
 	 */
 	function test_connection() {
 		return JETPACK__VERSION;

modules/shortcodes/soundcloud.php

Doc Comments +3 added lines, -3 removed lines

@@ -137,8 +137,8 @@ 
 /**
  * Plugin options getter
  *
- * @param  string|array $option  Option name
- * @param  mixed        $default Default value
+ * @param  string $option  Option name
+ * @param  string        $default Default value
  *
  * @return mixed                   Option value
  */
@@ -164,7 +164,7 @@ 
  *
  * @param  string $url
  *
- * @return boolean
+ * @return integer
  */
 function soundcloud_url_has_tracklist( $url ) {
 	return preg_match( '/^(.+?)\/(sets|groups|playlists)\/(.+?)$/', $url );

json-endpoints/class.wpcom-json-api-site-settings-v1-2-endpoint.php

Doc Comments +3 added lines

@@ -27,6 +27,9 @@
 	}
 
 
+	/**
+	 * @param string $key
+	 */
 	protected function get_locale( $key ) {
 		if ( 'locale' == $key ) {
 			if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {

sal/class.json-api-site-jetpack-base.php

Doc Comments +15 added lines

@@ -4,12 +4,27 @@
 require_once dirname( __FILE__ ) . '/class.json-api-site-base.php';
 
 abstract class Abstract_Jetpack_Site extends SAL_Site {
+
+	/**
+	 * @param string $name
+	 */
 	abstract protected function get_constant( $name );
 
+	/**
+	 * @param string $feature_name
+	 */
 	abstract protected function current_theme_supports( $feature_name );
 
+	/**
+	 * @param string $feature_name
+	 */
 	abstract protected function get_theme_support( $feature_name );
 
+	/**
+	 * @param string $name
+	 *
+	 * @return string
+	 */
 	abstract protected function get_mock_option( $name );
 
 	abstract protected function get_jetpack_version();

sal/class.json-api-post-base.php

Doc Comments +7 added lines

@@ -16,6 +16,9 @@ 
 	public $context;
 	public $site;
 
+	/**
+	 * @param Jetpack_Site $site
+	 */
 	function __construct( $site, $post, $context ) {
 		$this->post = $post;
 		$this->context = $context;
@@ -487,6 +490,10 @@ 
 		return $suggestions;
 	}
 
+	/**
+	 * @param string $taxonomy_type
+	 * @param string $context
+	 */
 	private function format_taxonomy( $taxonomy, $taxonomy_type, $context ) {
 		// Permissions
 		switch ( $context ) {

sal/class.json-api-links.php

Doc Comments +1 added lines, -2 removed lines

@@ -26,7 +26,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() {
@@ -117,7 +116,7 @@ 
 	 * This method is used in get_link() to construct meta links for API responses.
 	 * 
 	 * @param $template_path The generic endpoint path, e.g. /sites/%s
-	 * @param $path string The current endpoint path, relative to the version, e.g. /sites/12345
+	 * @param string $path string The current endpoint path, relative to the version, e.g. /sites/12345
 	 * @param $method string Request method used to access the endpoint path
 	 * @return string The current version, or otherwise the maximum version available
 	 */

class.json-api-endpoints.php

Doc Comments +5 added lines

@@ -1341,6 +1341,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 )
 	 */
@@ -1458,6 +1459,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 ) {