Automattic / jetpack

_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/theme-tools/featured-content.php

Doc Comments +1 added lines, -1 removed lines

@@ -646,7 +646,7 @@
  * handlers should be copied when the theme context is loaded by the REST API.
  *
  * @param array $copy_dirs Copy paths with actions to be copied
- * @return array Copy paths with featured content plugin
+ * @return string[] Copy paths with featured content plugin
  */
 function wpcom_rest_api_featured_content_copy_plugin_actions( $copy_dirs ) {
 	$copy_dirs[] = __FILE__;

json-endpoints/class.wpcom-json-api-update-post-v1-1-endpoint.php

Doc Comments +19 added lines

@@ -28,6 +28,11 @@ 
 
 	// /sites/%s/posts/new       -> $blog_id
 	// /sites/%s/posts/%d        -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 * @param integer $post_id
+	 */
 	function write_post( $path, $blog_id, $post_id ) {
 		global $wpdb;
 
@@ -704,6 +709,11 @@ 
 	}
 
 	// /sites/%s/posts/%d/delete -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 * @param integer $post_id
+	 */
 	function delete_post( $path, $blog_id, $post_id ) {
 		$post = get_post( $post_id );
 		if ( !$post || is_wp_error( $post ) ) {
@@ -743,6 +753,11 @@ 
 	}
 
 	// /sites/%s/posts/%d/restore -> $blog_id, $post_id
+
+	/**
+	 * @param string $path
+	 * @param integer $post_id
+	 */
 	function restore_post( $path, $blog_id, $post_id ) {
 		$args  = $this->query_args();
 		$post = get_post( $post_id );
@@ -763,6 +778,10 @@ 
 		return $this->get_post_by( 'ID', $post->ID, $args['context'] );
 	}
 
+	/**
+	 * @param boolean $delete_featured_image
+	 * @param string $featured_image
+	 */
 	protected function parse_and_set_featured_image( $post_id, $delete_featured_image, $featured_image ) {
 		if ( $delete_featured_image ) {
 			delete_post_thumbnail( $post_id );

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;