Automattic / jetpack

modules/wordads/wordads.php

Doc Comments +2 added lines, -2 removed lines

@@ -49,7 +49,7 @@ 
 	 * Convenience function for grabbing options from params->options
 	 *
 	 * @param  string $option the option to grab
-	 * @param  mixed  $default (optional)
+	 * @param  boolean  $default (optional)
 	 * @return option or $default if not set
 	 *
 	 * @since 4.5.0
@@ -494,7 +494,7 @@ 
 	/**
 	 * Check the reasons to bail before we attempt to insert ads.
 	 *
-	 * @return true if we should bail (don't insert ads)
+	 * @return boolean if we should bail (don't insert ads)
 	 *
 	 * @since 4.5.0
 	 */

modules/after-the-deadline/config-options.php

Doc Comments +9 added lines

@@ -6,6 +6,9 @@ 
 /*
  *   A convienence function to display the HTML for an AtD option
  */
+/**
+ * @param string $name
+ */
 function AtD_print_option( $name, $value, $options ) {
 	// Attribute-safe version of $name
 	$attr_name = sanitize_title( $name ); // Using sanitize_title since there's no comparable function for attributes
@@ -112,6 +115,9 @@ 
 /*
  *  Returns an array of AtD user options specified by $name
  */
+/**
+ * @param string $name
+ */
 function AtD_get_options( $user_id, $name ) {
 	$options_raw = AtD_get_setting( $user_id, $name, 'single' );
 
@@ -130,6 +136,9 @@ 
 /*
  *  Saves set of user options specified by $name from POST data
  */
+/**
+ * @param string $name
+ */
 function AtD_update_options( $user_id, $name ) {
 	/* We should probably run $_POST[name] through an esc_*() function... */
 	if ( isset( $_POST[ $name ] ) && is_array( $_POST[ $name ] ) ) {

modules/carousel/jetpack-carousel.php

Doc Comments +9 added lines

@@ -133,6 +133,9 @@ 
 		exit;
 	}
 
+	/**
+	 * @param string $version
+	 */
 	function asset_version( $version ) {
 		/**
 		 * Filter the version string used when enqueuing Carousel assets.
@@ -707,6 +710,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;
@@ -722,6 +728,9 @@ 
 		echo '</fieldset>';
 	}
 
+	/**
+	 * @param string $name
+	 */
 	function settings_select( $name, $values, $extra_text = '' ) {
 		if ( empty( $name ) || ! is_array( $values ) || empty( $values ) ) {
 			return;

modules/tiled-gallery/tiled-gallery/tiled-gallery-layout.php

Doc Comments +8 added lines

@@ -9,6 +9,11 @@ 
 	public $link;
 	public $grayscale;
 	public $columns;
+
+	/**
+	 * @param boolean $grayscale
+	 * @param integer $columns
+	 */
 	public function __construct( $attachments, $link, $grayscale, $columns ) {
 
 		$this->attachments           = $attachments;
@@ -39,6 +44,9 @@ 
 		return $html;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	private function template( $name, $context = null ) {
 		if ( ! in_array( $name, self::$templates ) ) {
 			return;

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/shortcodes/crowdsignal.php

Doc Comments +3 added lines

@@ -25,6 +25,9 @@
 		add_action( 'infinite_scroll_render', array( $this, 'crowdsignal_shortcode_infinite' ), 11 );
 	}
 
+	/**
+	 * @param string $survey_link
+	 */
 	private function get_async_code( array $settings, $survey_link ) {
 		$include = <<<CONTAINER
 ( function( d, c, j ) {

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;