Automattic / jetpack

projects/plugins/jetpack/_inc/lib/class.jetpack-password-checker.php

Doc Comments +1 added lines, -1 removed lines

@@ -410,7 +410,7 @@
 	 *
 	 * @param Mixed $needle the needle.
 	 * @param array $haystack the haystack.
-	 * @return is the needle not in the haystack?
+	 * @return boolean the needle not in the haystack?
 	 */
 	protected function negative_in_array( $needle, $haystack ) {
 		if ( in_array( $needle, $haystack, true ) ) {

projects/plugins/jetpack/_inc/lib/class.jetpack-search-performance-logger.php

Doc Comments +4 added lines

@@ -62,6 +62,10 @@
 		return $query->is_main_query() && $query->is_search();
 	}
 
+	/**
+	 * @param double $duration
+	 * @param boolean $was_jetpack_search
+	 */
 	private function record_query_time( $duration, $was_jetpack_search ) {
 		$this->stats[] = array( $was_jetpack_search, (int) ( $duration * 1000 ) );
 	}

projects/plugins/jetpack/_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) {

projects/plugins/jetpack/_inc/lib/core-api/load-wpcom-endpoints.php

Doc Comments +3 added lines

@@ -15,6 +15,9 @@
 	exit;
 }
 
+/**
+ * @param string $file_pattern
+ */
 function wpcom_rest_api_v2_load_plugin_files( $file_pattern ) {
 	$plugins = glob( dirname( __FILE__ ) . '/' . $file_pattern );
 

projects/plugins/jetpack/_inc/lib/debugger/class-jetpack-cxn-test-base.php

Doc Comments +1 added lines, -1 removed lines

@@ -199,7 +199,7 @@
 	 * @param string $type  Test type, async or direct. Optional, direct all tests.
 	 * @param string $group Testing group to check status of. Optional, default all tests.
 	 *
-	 * @return true|array True if all tests pass. Array of failed tests.
+	 * @return boolean True if all tests pass. Array of failed tests.
 	 */
 	public function pass( $type = 'all', $group = 'all' ) {
 		$results = $this->raw_results( $type, $group );

projects/plugins/jetpack/_inc/lib/functions.wp-notify.php

Doc Comments +1 added lines, -1 removed lines

@@ -228,7 +228,7 @@
  *
  * @param string $notify_moderator The value of the moderation_notify option.
  * @param int    $comment_id Comment ID.
- * @return boolean Returns false to shortcircuit the execution of wp_notify_moderator
+ * @return string|false Returns false to shortcircuit the execution of wp_notify_moderator
  */
 function jetpack_notify_moderator( $notify_moderator, $comment_id ) {
 

projects/plugins/jetpack/_inc/lib/icalendar-reader.php

Doc Comments +2 added lines, -4 removed lines

@@ -699,8 +699,7 @@ 
 	 * Render the events
 	 *
 	 * @param string $url (default: '')
-	 * @param string $context (default: 'widget') or 'shortcode'
-	 * @return mixed bool|string false on failure, rendered HTML string on success.
+	 * @return false|string bool|string false on failure, rendered HTML string on success.
 	 */
 	public function render( $url = '', $args = array() ) {
 
@@ -857,8 +856,7 @@ 
  * Wrapper function for iCalendarReader->render()
  *
  * @param string $url (default: '')
- * @param string $context (default: 'widget') or 'shortcode'
- * @return mixed bool|string false on failure, rendered HTML string on success.
+ * @return false|string bool|string false on failure, rendered HTML string on success.
  */
 function icalendar_render_events( $url = '', $args = array() ) {
 	$ical = new iCalendarReader();

projects/plugins/jetpack/_inc/lib/jetpack-wpes-query-builder/jetpack-wpes-query-builder.php

Doc Comments +9 added lines, -6 removed lines

@@ -85,7 +85,7 @@ 
 	 *
 	 * @param $function array A function structure to apply to the query
 	 *
-	 * @return void
+	 * @return Jetpack_WPES_Query_Builder
 	 */
 	public function add_weighting_function( $function ) {
 		$this->weighting_functions[] = $function;
@@ -100,10 +100,10 @@ 
 	 *
 	 * @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
+	 * @return Jetpack_WPES_Query_Builder
 	 */
 	public function add_function( $function, $params ) {
 		$this->functions[ $function ][] = $params;
@@ -119,10 +119,10 @@ 
 	 *
 	 * @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
+	 * @return Jetpack_WPES_Query_Builder
 	 */
 	public function add_decay( $function, $params ) {
 		$this->decays[ $function ][] = $params;
@@ -137,7 +137,7 @@ 
 	 *
 	 * @param $mode string name of how to score
 	 *
-	 * @return void
+	 * @return Jetpack_WPES_Query_Builder
 	 */
 	public function add_score_mode_to_functions( $mode='multiply' ) {
 		$this->functions_score_mode = $mode;
@@ -163,6 +163,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $aggs_name
+	 */
 	public function add_aggs( $aggs_name, $aggs ) {
 		$this->aggs_query = true;
 		$this->aggs[$aggs_name] = $aggs;

projects/plugins/jetpack/_inc/lib/markdown/extra.php

Doc Comments +27 added lines, -1 removed lines

@@ -69,7 +69,7 @@ 
  *
  * @since 5.9
  *
- * @return string Length of the multibyte string
+ * @return integer Length of the multibyte string
  *
  */
 function jetpack_utf8_strlen( $text ) {
@@ -169,6 +169,9 @@ 
 	}
 
 
+	/**
+	 * @param string $text
+	 */
 	function transform($text) {
 	#
 	# Main function. Performs some preprocessing on the input text
@@ -903,6 +906,10 @@ 
 
 	public $list_level = 0;
 
+	/**
+	 * @param string $list_str
+	 * @param string $marker_any_re
+	 */
 	function processListItems($list_str, $marker_any_re) {
 	#
 	#	Process the contents of a single ordered or unordered list, splitting it
@@ -1006,6 +1013,9 @@ 
 	}
 
 
+	/**
+	 * @param string $code
+	 */
 	function makeCodeSpan($code) {
 	#
 	# Create a code span markup for $code. Called from handleSpanToken.
@@ -1498,6 +1508,9 @@ 
 	# hanlde UTF-8 if the default function does not exist.
 	public $utf8_strlen = 'mb_strlen';
 
+	/**
+	 * @param string $text
+	 */
 	function detab($text) {
 	#
 	# Replace tabs with the appropriate amount of space.
@@ -2042,6 +2055,12 @@ 
 
 		return array($parsed, $text);
 	}
+
+	/**
+	 * @param string $text
+	 * @param string $hash_method
+	 * @param boolean $md_attr
+	 */
 	function _hashHTMLBlocks_inHTML($text, $hash_method, $md_attr) {
 	#
 	# Parse HTML, calling _HashHTMLBlocks_InMarkdown for block tags.
@@ -2706,6 +2725,9 @@ 
 	}
 
 
+	/**
+	 * @return string
+	 */
 	function processDefListItems($list_str) {
 	#
 	#	Process the contents of a single definition list, splitting it
@@ -2817,6 +2839,10 @@ 
 
 		return $text;
 	}
+
+	/**
+	 * @param string[] $matches
+	 */
 	function _doFencedCodeBlocks_callback($matches) {
 		$classname =& $matches[2];
 		$attrs     =& $matches[3];