Automattic / jetpack

packages/analyzer/src/Invocations.php

Doc Comments +3 added lines

@@ -37,6 +37,9 @@
 		}
 	}
 
+	/**
+	 * @param string $root
+	 */
 	public function scan_dir( $root, $exclude = array() ) {
 		$filter = function ( $file, $key, $iterator ) use ( $exclude ) {
 			if ( $iterator->hasChildren() && ! in_array( $file->getFilename(), $exclude ) ) {

packages/analyzer/src/Invocations/Visitor.php

Doc Comments +3 added lines

@@ -9,6 +9,9 @@
 	private $invocations;
 	private $file_path;
 
+	/**
+	 * @param  $invocations
+	 */
 	public function __construct( $file_path, $invocations ) {
 		$this->file_path   = $file_path;
 		$this->invocations = $invocations;

packages/analyzer/src/PersistentList.php

Doc Comments +1 added lines

@@ -31,6 +31,7 @@
 
 	/**
 	 * Saves the items to a file and returns the file contents
+	 * @param string $file_path
 	 */
 	public function save( $file_path, $allow_empty = true ) {
 

packages/analyzer/src/Declarations/Visitor.php

Doc Comments +3 added lines

@@ -11,6 +11,9 @@
 	private $declarations;
 	private $current_relative_path;
 
+	/**
+	 * @param  $declarations
+	 */
 	public function __construct( $current_relative_path, $declarations ) {
 		$this->current_relative_path = $current_relative_path;
 		$this->declarations          = $declarations;

modules/contact-form/grunion-contact-form.php

Doc Comments +44 added lines, -2 removed lines

@@ -302,6 +302,9 @@ 
 		return Grunion_Contact_Form::parse( $atts, do_blocks( $content ) );
 	}
 
+	/**
+	 * @param string $type
+	 */
 	public static function block_attributes_to_shortcode_attributes( $atts, $type ) {
 		$atts['type'] = $type;
 		if ( isset( $atts['className'] ) ) {
@@ -1925,7 +1928,6 @@ 
 	 *
 	 * @see ::style()
 	 * @internal
-	 * @param bool $style
 	 */
 	static function _style_on() {
 		return self::style( true );
@@ -2096,6 +2098,7 @@ 
 	 *
 	 * @param int                         $feedback_id
 	 * @param object Grunion_Contact_Form $form
+	 * @param Grunion_Contact_Form $form
 	 *
 	 * @return string $message
 	 */
@@ -2220,7 +2223,7 @@ 
 	 *
 	 * @param array       $attributes Key => Value pairs as parsed by shortcode_parse_atts()
 	 * @param string|null $content The shortcode's inner content: [contact-field]$content[/contact-field]
-	 * @return HTML for the contact form field
+	 * @return string for the contact form field
 	 */
 	static function parse_contact_field( $attributes, $content ) {
 		// Don't try to parse contact form fields if not inside a contact form
@@ -3260,6 +3263,9 @@ 
 
 	}
 
+	/**
+	 * @param string $type
+	 */
 	function render_input_field( $type, $id, $value, $class, $placeholder, $required ) {
 		return "<input
 					type='". esc_attr( $type ) ."'
@@ -3271,24 +3277,40 @@ 
 				/>\n";
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_email_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'email', $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'email', $id, $value, $class, $placeholder, $required );
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_telephone_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'telephone', $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'tel', $id, $value, $class, $placeholder, $required );
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_url_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'url', $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'url', $id, $value, $class, $placeholder, $required );
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_textarea_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'textarea', 'contact-form-comment-' . $id, $label, $required, $required_field_text );
 		$field .= "<textarea
@@ -3303,6 +3325,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	function render_radio_field( $id, $label, $value, $class, $required, $required_field_text ) {
 		$field = $this->render_label( '', $id, $label, $required, $required_field_text );
 		foreach ( (array) $this->get_attribute( 'options' ) as $optionIndex => $option ) {
@@ -3324,6 +3349,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	function render_checkbox_field( $id, $label, $value, $class, $required, $required_field_text ) {
 		$field = "<label class='grunion-field-label checkbox" . ( $this->is_error() ? ' form-error' : '' ) . "'>";
 			$field .= "\t\t<input type='checkbox' name='" . esc_attr( $id ) . "' value='" . esc_attr__( 'Yes', 'jetpack' ) . "' " . $class . checked( (bool) $value, true, false ) . ' ' . ( $required ? "required aria-required='true'" : '' ) . "/> \n";
@@ -3333,6 +3361,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	function render_checkbox_multiple_field( $id, $label, $value, $class, $required, $required_field_text  ) {
 		$field = $this->render_label( '', $id, $label, $required, $required_field_text );
 		foreach ( (array) $this->get_attribute( 'options' ) as $optionIndex => $option ) {
@@ -3348,6 +3379,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	function render_select_field( $id, $label, $value, $class, $required, $required_field_text ) {
 		$field = $this->render_label( 'select', $id, $label, $required, $required_field_text );
 		$field  .= "\t<select name='" . esc_attr( $id ) . "' id='" . esc_attr( $id ) . "' " . $class . ( $required ? "required aria-required='true'" : '' ) . ">\n";
@@ -3365,6 +3399,10 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_date_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 
 		$field = $this->render_label( 'date', $id, $label, $required, $required_field_text );
@@ -3395,6 +3433,10 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_default_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder, $type ) {
 		$field = $this->render_label( $type, $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'text', $id, $value, $class, $placeholder, $required );

modules/notes.php

Doc Comments +3 added lines

@@ -36,6 +36,9 @@
 		add_action( 'init', array( &$this, 'action_init' ) );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	function wpcom_static_url($file) {
 		$i = hexdec( substr( md5( $file ), -1 ) ) % 2;
 		return 'https://s' . $i . '.wp.com' . $file;

_inc/lib/class.media.php

Doc Comments +7 added lines, -3 removed lines

@@ -84,7 +84,7 @@ 
 	/**
 	 * Return an array of allowed mime_type items used to upload a media file.
 	 *
-	 * @return array mime_type array
+	 * @return string[] mime_type array
 	 */
 	static function get_allowed_mime_types( $default_mime_types ) {
 		return array_unique( array_merge( $default_mime_types, array(
@@ -252,7 +252,7 @@ 
 	 * @param  object $media_item - media post object
 	 * @param  file $file - file recently added
 	 * @param  bool $has_original_media - condition is the original media has been already added
-	 * @return bool `true` if the item has been added. Otherwise `false`.
+	 * @return false|null `true` if the item has been added. Otherwise `false`.
 	 */
 	public static function register_revision( $media_item, $file, $has_original_media ) {
 		if ( is_wp_error( $file ) || ! $has_original_media ) {
@@ -280,6 +280,9 @@ 
 		return $original;
 	}
 
+	/**
+	 * @param string $pathname
+	 */
 	public static function delete_file( $pathname ) {
 		if ( ! file_exists( $pathname ) || ! is_file( $pathname ) ) {
 			// let's touch a fake file to try to `really` remove the media file
@@ -295,7 +298,7 @@ 
 	 *
 	 * @param  number $media_id - media post ID
 	 * @param  string $filename - basename of the file ( name-of-file.ext )
-	 * @return bool `true` is the file has been removed, `false` if not.
+	 * @return boolean|null `true` is the file has been removed, `false` if not.
 	 */
 	private static function delete_media_history_file( $media_id, $filename ) {
 		$attached_path = get_attached_file( $media_id );
@@ -365,6 +368,7 @@ 
 	 *
 	 * @param  number $media_id - media post ID
 	 * @param  number [$limit] - maximun amount of items. 20 as default.
+	 * @param integer $limit
 	 * @return array items removed from `revision_history`
 	 */
 	public static function limit_revision_history( $media_id, $limit = null) {

packages/analyzer/src/Invocations/Function_Call.php

Doc Comments +3 added lines

@@ -15,6 +15,9 @@
 	public $line;
 	public $func_name;
 
+	/**
+	 * @param string $func_name
+	 */
 	public function __construct( $path, $line, $func_name ) {
 		$this->path      = $path;
 		$this->line      = $line;

_inc/lib/class.color.php

Doc Comments +13 added lines, -1 removed lines

@@ -149,6 +149,9 @@ 
 
 	/**
 	 * Helper function for Jetpack_Color::fromHsl()
+	 * @param double $p
+	 * @param double $q
+	 * @param integer $t
 	 */
 	private function hue2rgb( $p, $q, $t ) {
 		if ( $t < 0 ) $t += 1;
@@ -498,7 +501,7 @@ 
 	 *
 	 * @param Jetpack_Color $color
 	 *
-	 * @return int
+	 * @return double
 	 */
 	public function getDistanceRgbFrom(Jetpack_Color $color)
 	{
@@ -687,6 +690,9 @@ 
 		return $this->incrementLightness( $amount );
 	}
 
+	/**
+	 * @param integer $amount
+	 */
 	public function incrementLightness( $amount ) {
 		$hsl = $this->toHsl();
 		extract( $hsl );
@@ -704,6 +710,9 @@ 
 		return $this->incrementSaturation( - $amount );
 	}
 
+	/**
+	 * @param integer $amount
+	 */
 	public function incrementSaturation( $amount ) {
 		$hsl = $this->toHsl();
 		extract( $hsl );
@@ -744,6 +753,9 @@ 
 		return $this->incrementHue( $incr );
 	}
 
+	/**
+	 * @param integer $amount
+	 */
 	public function incrementHue( $amount ) {
 		$hsl = $this->toHsl();
 		extract( $hsl );