Automattic / jetpack

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;

sync/class.jetpack-sync-module-posts.php

Doc Comments +3 added lines

@@ -105,6 +105,9 @@
 		return isset( $importers[ $importer ] ) ? $importers[ $importer ][0] : 'Unknown Importer';
 	}
 
+	/**
+	 * @param string $class_name
+	 */
 	private function is_importer( $backtrace, $class_name ) {
 		foreach ( $backtrace as $trace ) {
 			if ( strpos( $trace, $class_name ) !== false ) {

sync/class.jetpack-sync-functions.php

Doc Comments +7 added lines

@@ -148,6 +148,7 @@ 
 	 * Helper function that is used when getting home or siteurl values. Decides
 	 * whether to get the raw or filtered value.
 	 *
+	 * @param string $url_type
 	 * @return string
 	 */
 	public static function get_raw_or_filtered_url( $url_type ) {
@@ -197,6 +198,9 @@ 
 		return self::get_protocol_normalized_url( 'main_network_site_url', network_site_url() );
 	}
 
+	/**
+	 * @param string $callable
+	 */
 	public static function get_protocol_normalized_url( $callable, $new_value ) {
 		$option_key = self::HTTPS_CHECK_OPTION_PREFIX . $callable;
 
@@ -236,6 +240,9 @@ 
 		return $value;
 	}
 
+	/**
+	 * @param string $url_function
+	 */
 	public static function normalize_www_in_url( $option, $url_function ) {
 		$url        = wp_parse_url( call_user_func( $url_function ) );
 		$option_url = wp_parse_url( get_option( $option ) );

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

modules/sitemaps/sitemap-buffer-master.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
  */
 class Jetpack_Sitemap_Buffer_Master 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 );
 

modules/sitemaps/sitemap-buffer-news.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
  */
 class Jetpack_Sitemap_Buffer_News 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 );
 

modules/sitemaps/sitemap-buffer-page.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
  */
 class Jetpack_Sitemap_Buffer_Page 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 );
 

modules/sitemaps/sitemap-buffer-video.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
  */
 class Jetpack_Sitemap_Buffer_Video 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 );
 

modules/sitemaps/sitemap-buffer.php

Doc Comments +3 added lines, -3 removed lines

@@ -136,7 +136,7 @@ 
 	 *
 	 * @param string $item The item to be added.
 	 *
-	 * @return bool True if the append succeeded, False if not.
+	 * @return boolean|null True if the append succeeded, False if not.
 	 */
 	public function try_to_add_item( $item ) {
 		_deprecated_function(
@@ -155,7 +155,7 @@ 
 	 *
 	 * @since 5.3.0
 	 *
-	 * @param array $array The item to be added.
+	 * @param string $array The item to be added.
 	 *
 	 * @return bool True if the append succeeded, False if not.
 	 */
@@ -280,7 +280,7 @@ 
 	 * @param DOMElement $parent (optional) an element to which new children should be added.
 	 * @param DOMDocument $root (optional) the parent document.
 	 *
-	 * @return string|DOMDocument The rendered XML string or an object if root element is specified.
+	 * @return null|DOMNode The rendered XML string or an object if root element is specified.
 	 */
 	protected function array_to_xml_string( $array, $parent = null, $root = null ) {
 		$return_string = false;