Automattic / jetpack

modules/related-posts/jetpack-related-posts.php

Doc Comments +5 added lines

@@ -294,6 +294,9 @@ 
 		return $this->_options;
 	}
 	
+	/**
+	 * @param string $option_name
+	 */
 	public function get_option( $option_name ) {
 		$options = $this->get_options();
 		
@@ -1428,6 +1431,8 @@ 
 	 * Enqueues assets needed to do async loading of related posts.
 	 *
 	 * @uses wp_enqueue_script, wp_enqueue_style, plugins_url
+	 * @param boolean $script
+	 * @param boolean $style
 	 * @return null
 	 */
 	protected function _enqueue_assets( $script, $style ) {

modules/stats.php

Doc Comments +2 added lines, -2 removed lines

@@ -246,7 +246,7 @@ 
  * Get Stats Options.
  *
  * @access public
- * @param mixed $option Option.
+ * @param string $option Option.
  * @return mixed|null.
  */
 function stats_get_option( $option ) {
@@ -651,7 +651,7 @@ 
  * Stats Convert Chart URLs.
  *
  * @access public
- * @param mixed $html HTML.
+ * @param string $html HTML.
  * @return string
  */
 function stats_convert_chart_urls( $html ) {

modules/shortcodes/soundcloud.php

Doc Comments +2 added lines, -2 removed lines

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

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

modules/widgets/internet-defense-league.php

Doc Comments +3 added lines

@@ -129,6 +129,9 @@
 		echo '<p>' . sprintf( _x( 'Learn more about the %s', 'the Internet Defense League', 'jetpack' ), '<a href="https://www.internetdefenseleague.org/">Internet Defense League</a>' ) . '</p>';
 	}
 
+	/**
+	 * @param string $field_name
+	 */
 	public function select( $field_name, $options, $default = null ) {
 		echo '<select class="widefat" name="' . $this->get_field_name( $field_name ) . '">';
 		foreach ( $options as $option_slug => $option_name ) {

sal/class.json-api-links.php

Doc Comments +1 added lines, -2 removed lines

@@ -29,7 +29,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() {
@@ -129,7 +128,7 @@ 
 	 * This method is used in get_link() to construct meta links for API responses.
 	 * 
 	 * @param $template_path string 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 $request_method string Request method used to access the endpoint path
 	 * @return string The current version, or otherwise the maximum version available
 	 */

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

Doc Comments +13 added lines

@@ -4,10 +4,20 @@ 
 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 );
 
 	abstract protected function get_mock_option( $name );
@@ -16,6 +26,9 @@ 
 
 	abstract public function get_updates();
 
+	/**
+	 * @return string
+	 */
 	abstract protected function main_network_site();
 
 	abstract protected function wp_version();

class.json-api.php

Doc Comments +17 added lines

@@ -33,6 +33,9 @@ 
 	public $extra_headers = array();
 
 	/**
+	 * @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 ) {
@@ -335,6 +338,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;
@@ -533,11 +539,18 @@ 
 		return json_encode( $data );
 	}
 
+	/**
+	 * @param string $needle
+	 */
 	function ends_with( $haystack, $needle ) {
 		return $needle === substr( $haystack, -strlen( $needle ) );
 	}
 
 	// Returns the site's blog_id in the WP.com ecosystem
+
+	/**
+	 * @return integer
+	 */
 	function get_blog_id_for_output() {
 		return $this->token_details['blog_id'];
 	}
@@ -560,6 +573,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.

modules/videopress/class.jetpack-videopress.php

Doc Comments +2 added lines, -2 removed lines

@@ -245,7 +245,7 @@ 
 	/**
 	 * A work-around / hack to make it possible to go to the media library with the add new box open.
 	 *
-	 * @return bool
+	 * @return false|null
 	 */
 	public function print_in_footer_open_media_add_new() {
 		global $pagenow;
@@ -339,7 +339,7 @@ 
 	/**
 	 * @param array $extensions
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function add_videopress_extenstion( $extensions ) {
 		$extensions[] = 'videopress';