Automattic / jetpack

_inc/lib/functions.wp-notify.php

Doc Comments +1 added lines, -1 removed lines

@@ -201,7 +201,7 @@
 	 * should be notified, overriding the site setting.
 	 *
 	 * @param int $comment_id Comment ID.
-	 * @return true Always returns true.
+	 * @return boolean Always returns true.
 	 */
 	function wp_notify_moderator( $comment_id ) {
 		global $wpdb;

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

Doc Comments +4 added lines

@@ -58,6 +58,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, intval( $duration * 1000 ) );
 	}

modules/search/class.jetpack-search-helpers.php

Doc Comments -1 removed lines

@@ -76,7 +76,6 @@
 	 * @since 5.8.0
 	 *
 	 * @param string|array $key   Query key or keys to remove.
-	 * @param bool|string  $query Optional. A URL to act upon.  Defaults to the current search URL.
 	 *
 	 * @return string New URL query string (unescaped).
 	 */

_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];

_inc/class.jetpack-provision.php

Doc Comments +3 added lines

@@ -249,6 +249,9 @@
 		}
 	}
 
+	/**
+	 * @param string $access_token
+	 */
 	private static function verify_token( $access_token ) {
 		$request = array(
 			'headers' => array(

_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;

json-endpoints/class.wpcom-json-api-list-post-type-taxonomies-endpoint.php

Doc Comments +3 added lines

@@ -75,6 +75,9 @@
 		);
 	}
 
+	/**
+	 * @param string $post_type
+	 */
 	protected function localize_initial_taxonomies( $post_type ) {
 		/** This filter is documented in jetpack/json-endpoints/class.wpcom-json-api-list-post-types-endpoint.php */
 		if ( ! apply_filters( 'rest_api_localize_response', false ) ) {

modules/theme-tools.php

Doc Comments +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
  * @access private
  * @param string $key
  * @param array $files
- * @return void
+ * @return WP_Error|null
  */
 function _jetpack_require_compat_file( $key, $files ) {
 	if ( ! is_string( $key ) ) {

json-endpoints/class.wpcom-json-api-edit-media-v1-2-endpoint.php

Doc Comments +3 added lines, -3 removed lines

@@ -101,7 +101,7 @@ 
 	 * Update the media post grabbing the post values from
 	 * the `attrs` parameter
 	 *
-	 * @param  {Number} $media_id - post media ID
+	 * @param  integer $media_id - post media ID
 	 * @param  {Object} $attrs - `attrs` parameter sent from the client in the request body
 	 * @return
 	 */
@@ -202,7 +202,7 @@ 
 	 * Save the given temporal file in a local folder.
 	 *
 	 * @param  {Array} $file_array
-	 * @param  {Number} $media_id
+	 * @param  integer $media_id
 	 * @return {Array|WP_Error} An array with information about the new file saved or a WP_Error is something went wrong.
 	 */
 	private function save_temporary_file( $file_array, $media_id ) {
@@ -277,7 +277,7 @@ 
 	/**
 	 * Get the image from a remote url and then save it locally.
 	 *
-	 * @param  {Number} $media_id - media post ID
+	 * @param  integer $media_id - media post ID
 	 * @param  {String} $url - image URL to save locally
 	 * @return {Array|WP_Error} An array with information about the new file saved or a WP_Error is something went wrong.
 	 */