Automattic / jetpack

modules/theme-tools/featured-content.php

Doc Comments +1 added lines, -1 removed lines

@@ -699,7 +699,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__;

modules/theme-tools/infinite-scroll.php

Doc Comments -1 removed lines

@@ -40,7 +40,6 @@
 /**
  * Prevent IS from being activated if theme doesn't support it
  *
- * @param bool $can_activate
  * @filter jetpack_can_activate_infinite-scroll
  * @return bool
  */

modules/theme-tools/responsive-videos.php

Doc Comments +1 added lines

@@ -29,6 +29,7 @@
 /**
  * Adds a wrapper to videos and enqueue script
  *
+ * @param string $html
  * @return string
  */
 function jetpack_responsive_videos_embed_html( $html ) {

modules/sitemaps/sitemap-buffer.php

Doc Comments +2 added lines, -2 removed lines

@@ -154,7 +154,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.
 	 */
@@ -283,7 +283,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;

modules/protect/math-fallback.php

Doc Comments +2 added lines, -2 removed lines

@@ -26,7 +26,7 @@ 
 		/**
 		 * Verifies that a user answered the math problem correctly while logging in.
 		 *
-		 * @return bool Returns true if the math is correct
+		 * @return boolean|null Returns true if the math is correct
 		 * @throws Error if insuffient $_POST variables are present.
 		 * @throws Error message if the math is wrong
 		 */
@@ -109,7 +109,7 @@ 
 		/**
 		 * Requires a user to solve a simple equation. Added to any WordPress login form.
 		 *
-		 * @return VOID outputs html
+		 * @return string|null outputs html
 		 */
 		static function math_form() {
 			// Check if jpp_math_pass cookie is set and it matches valid transient

modules/publicize/ui.php

Doc Comments +1 added lines, -1 removed lines

@@ -415,7 +415,7 @@
 	 *
 	 * @param array $connections_data
 	 *
-	 * @return array {
+	 * @return string {
 	 *     Array of content for generating connection form.
 	 *
 	 *     @type string HTML content of form

modules/publicize/publicize-jetpack.php

Doc Comments +3 added lines

@@ -682,6 +682,9 @@
 		$this->options_save_other( 'linkedin' );
 	}
 
+	/**
+	 * @param string $service_name
+	 */
 	function options_save_other( $service_name ) {
 		// Nonce check
 		check_admin_referer( 'save_' . $service_name . '_token_' . $_REQUEST['connection'] );

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

Doc Comments +3 added lines

@@ -244,6 +244,9 @@
 		}
 	}
 
+	/**
+	 * @param string $capability
+	 */
 	protected function current_user_can( $capability, $plugin = null ) {
 		if ( $plugin ) {
 			return current_user_can( $capability, $plugin );

modules/carousel/jetpack-carousel.php

Doc Comments +12 added lines

@@ -129,6 +129,9 @@ 
 		return apply_filters( 'jp_carousel_load_for_images_linked_to_file', false );
 	}
 
+	/**
+	 * @param string $version
+	 */
 	function asset_version( $version ) {
 		/**
 		 * Filter the version string used when enqueuing Carousel assets.
@@ -511,6 +514,9 @@ 
 		return $attr;
 	}
 
+	/**
+	 * @param string $html
+	 */
 	function add_data_to_container( $html ) {
 		global $post;
 		if (
@@ -757,6 +763,9 @@ 
 		return ( 1 == $value ) ? 1 : 0;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function settings_checkbox( $name, $label_text, $extra_text = '', $default_to_checked = true ) {
 		if ( empty( $name ) ) {
 			return;
@@ -772,6 +781,9 @@ 
 		echo '</fieldset>';
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function settings_select( $name, $values, $extra_text = '' ) {
 		if ( empty( $name ) || ! is_array( $values ) || empty( $values ) ) {
 			return;