Automattic / jetpack

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

json-endpoints/jetpack/class.jetpack-json-api-plugins-endpoint.php

Doc Comments +3 added lines

@@ -170,6 +170,9 @@
 	}
 
 
+	/**
+	 * @param string $plugin
+	 */
 	protected function validate_plugin( $plugin ) {
 		if ( ! isset( $plugin) || empty( $plugin ) ) {
 			return new WP_Error( 'missing_plugin', __( 'You are required to specify a plugin to activate.', 'jetpack' ), 400 );

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

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

_inc/lib/jetpack-wpes-query-builder/jetpack-wpes-query-builder.php

Doc Comments +5 added lines, -2 removed lines

@@ -77,7 +77,7 @@ 
 	 *
 	 * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html
 	 *
-	 * @param $function string name of the function
+	 * @param string $function string name of the function
 	 * @param $params array functions parameters
 	 *
 	 * @return void
@@ -94,7 +94,7 @@ 
 	 *
 	 * @see https://www.elastic.co/guide/en/elasticsearch/guide/current/decay-functions.html
 	 *
-	 * @param $function string name of the decay function - linear, exp, or gauss
+	 * @param string $function string name of the decay function - linear, exp, or gauss
 	 * @param $params array The decay functions parameters, passed to ES directly
 	 *
 	 * @return void
@@ -124,6 +124,9 @@ 
 		$this->query_bool_boost = $boost;
 	}
 
+	/**
+	 * @param string $aggs_name
+	 */
 	public function add_aggs( $aggs_name, $aggs ) {
 		$this->aggs_query = true;
 		$this->aggs[$aggs_name] = $aggs;

modules/simple-payments/simple-payments.php

Doc Comments +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
 	 * Allows custom post types to be used by REST API.
 	 * @param $post_types
 	 * @see hook 'rest_api_allowed_post_types'
-	 * @return array
+	 * @return string[]
 	 */
 	function allow_rest_api_types( $post_types ) {
 		$post_types[] = self::$post_type_order;

modules/sitemaps/sitemap-buffer-image.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
  */
 class Jetpack_Sitemap_Buffer_Image extends Jetpack_Sitemap_Buffer {
 
+	/**
+	 * @param integer $byte_limit
+	 */
 	public function __construct( $item_limit, $byte_limit, $time = '1970-01-01 00:00:00' ) {
 		parent::__construct( $item_limit, $byte_limit, $time );