Automattic / jetpack

class.json-api.php

Doc Comments +18 added lines, -1 removed lines

@@ -35,6 +35,9 @@ 
 	public $amp_source_origin = null;
 
 	/**
+	 * @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 ) {
@@ -348,6 +351,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;
@@ -572,11 +578,18 @@ 
 		return wp_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'];
 	}
@@ -599,6 +612,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.
@@ -648,7 +665,7 @@ 
 	/**
 	 * Counts the number of comments on a site, excluding certain comment types.
 	 *
-	 * @param $post_id int Post ID.
+	 * @param integer $post_id int Post ID.
 	 * @return array Array of counts, matching the output of https://developer.wordpress.org/reference/functions/get_comment_count/.
 	 */
 	public function wp_count_comments( $post_id ) {

class.json-api-endpoints.php

Doc Comments +6 added lines, -1 removed lines

@@ -1540,6 +1540,7 @@ 
 	 * timezone set in the options table for the blog or the GMT offset.
 	 *
 	 * @param datetime string $date_string Date to parse.
+	 * @param string $date_string
 	 *
 	 * @return array( $local_time_string, $gmt_time_string )
 	 */
@@ -1649,6 +1650,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 ) {
@@ -2073,7 +2078,7 @@ 
 	 * Get an array of all valid AMP origins for a blog's siteurl.
 	 *
 	 * @param string $siteurl Origin url of the API request.
-	 * @return array
+	 * @return string[]
 	 */
 	public function get_amp_cache_origins( $siteurl ) {
 		$host = parse_url( $siteurl, PHP_URL_HOST );

extensions/blocks/podcast-player/podcast-player.php

Doc Comments +1 added lines, -1 removed lines

@@ -235,7 +235,7 @@
  * @param string $name           Template name, available in `./templates` folder.
  * @param array  $template_props Template properties. Optional.
  * @param bool   $print          Render template. True as default.
- * @return false|string          HTML markup or false.
+ * @return string|null          HTML markup or false.
  */
 function render( $name, $template_props = array(), $print = true ) {
 	if ( ! strpos( $name, '.php' ) ) {

modules/sharedaddy/recaptcha.php

Doc Comments +1 added lines, -1 removed lines

@@ -68,7 +68,7 @@
 	/**
 	 * Get default config for this reCAPTCHA instance.
 	 *
-	 * @return array Default config
+	 * @return string Default config
 	 */
 	public function get_default_config() {
 		return array(

modules/stats.php

Doc Comments +4 added lines, -4 removed lines

@@ -290,7 +290,7 @@ 
  * Get Stats Options.
  *
  * @access public
- * @param mixed $option Option.
+ * @param string $option Option.
  * @return mixed|null.
  */
 function stats_get_option( $option ) {
@@ -744,7 +744,7 @@ 
  * Stats Convert Chart URLs.
  *
  * @access public
- * @param mixed $html HTML.
+ * @param string $html HTML.
  * @return string
  */
 function stats_convert_chart_urls( $html ) {
@@ -1414,7 +1414,7 @@ 
  *
  * @access public
  * @param mixed $get Get.
- * @param mixed $url URL.
+ * @param string $url URL.
  * @return void
  */
 function stats_print_wp_remote_error( $get, $url ) {
@@ -1556,7 +1556,7 @@ 
  * Stats get remote CSV.
  *
  * @access public
- * @param mixed $url URL.
+ * @param string $url URL.
  * @return array
  */
 function stats_get_remote_csv( $url ) {

modules/subscriptions/views.php

Doc Comments +1 added lines, -1 removed lines

@@ -557,7 +557,7 @@
 	/**
 	 * The default args for rendering a subscription form.
 	 *
-	 * @return array
+	 * @return string
 	 */
 	static function defaults() {
 		$defaults = array(

modules/widgets/blog-stats.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
 	 *
 	 * These values are used in new widgets.
 	 *
-	 * @return array Array of default values for the Widget's options
+	 * @return string Array of default values for the Widget's options
 	 */
 	public function defaults() {
 		return array(

modules/widgets/eu-cookie-law.php

Doc Comments +1 added lines, -1 removed lines

@@ -116,7 +116,7 @@
 		 *
 		 * These values are used in new widgets.
 		 *
-		 * @return array Default values for the widget options.
+		 * @return string Default values for the widget options.
 		 */
 		public function defaults() {
 			return array(

modules/widgets/facebook-likebox.php

Doc Comments +6 added lines

@@ -231,6 +231,9 @@ 
 		<?php
 	}
 
+	/**
+	 * @return string
+	 */
 	function get_default_args() {
 		$defaults = array(
 			'href'         => '',
@@ -292,6 +295,9 @@ 
 		return ( false !== strpos( $url, 'facebook.com' ) ) ? true : false;
 	}
 
+	/**
+	 * @param integer $value
+	 */
 	function normalize_int_value( $value, $default = 0, $max = 0, $min = 0 ) {
 		$value = (int) $value;