Automattic / jetpack

projects/plugins/jetpack/extensions/blocks/premium-content/_inc/subscription-service/class-jwt.php

Doc Comments +1 added lines, -1 removed lines

@@ -186,7 +186,7 @@
 	 * Sign a string with a given key and algorithm.
 	 *
 	 * @param string          $msg    The message to sign.
-	 * @param string|resource $key    The secret key.
+	 * @param string $key    The secret key.
 	 * @param string          $alg    The signing algorithm.
 	 *                                Supported algorithms are 'HS256', 'HS384', 'HS512' and 'RS256'.
 	 *

projects/plugins/jetpack/extensions/blocks/premium-content/_inc/subscription-service/class-token-subscription-service.php

Doc Comments +1 added lines, -1 removed lines

@@ -149,7 +149,7 @@
 	/**
 	 * Get the token stored in the auth cookie.
 	 *
-	 * @return ?string
+	 * @return string
 	 */
 	private function token_from_cookie() {
 		if ( isset( $_COOKIE[ self::JWT_AUTH_TOKEN_COOKIE_NAME ] ) ) {

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

Doc Comments +9 added lines, -6 removed lines

@@ -91,7 +91,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 ) {
 		// check for danger.
@@ -114,10 +114,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;
@@ -133,10 +133,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;
@@ -151,7 +151,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;
@@ -177,6 +177,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $aggs_name
+	 */
 	public function add_aggs( $aggs_name, $aggs ) {
 		$this->aggs_query = true;
 		$this->aggs[$aggs_name] = $aggs;

projects/packages/analyzer/src/class-declarations.php

Doc Comments +4 added lines

@@ -22,6 +22,7 @@ 
 
 	/**
 	 * Scan every PHP in the root
+	 * @param string $root
 	 */
 	public function scan( $root, $exclude = array() ) {
 		if ( is_dir( $root ) ) {
@@ -33,6 +34,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $root
+	 */
 	public function scan_dir( $root, $exclude = array() ) {
 
 		if ( is_null( $exclude ) || ! is_array( $exclude ) ) {

projects/packages/connection/src/class-nonce-handler.php

Doc Comments +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
 	 * @param int $cutoff_timestamp All nonces added before this timestamp will be removed.
 	 * @param int $time_limit How long the cleanup can run (in seconds).
 	 *
-	 * @return true
+	 * @return boolean
 	 */
 	public function clean_all( $cutoff_timestamp = PHP_INT_MAX, $time_limit = 20 ) {
 		// phpcs:ignore Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed

projects/plugins/beta/class-jetpack-beta.php

Doc Comments +4 added lines, -2 removed lines

@@ -639,6 +639,7 @@ 
 	 * Fetch latest Jetpack version.
 	 *
 	 * @param bool $is_dev_version - If JP Dev version is being queried.
+	 * @return string
 	 */
 	public static function get_new_jetpack_version( $is_dev_version = false ) {
 		$manifest = self::get_beta_manifest();
@@ -714,6 +715,7 @@ 
 	 *
 	 * @param string $branch  - Branch.
 	 * @param string $section - Section.
+	 * @return string
 	 */
 	public static function get_install_url( $branch = null, $section = null ) {
 		if ( is_null( $section ) ) {
@@ -769,7 +771,7 @@ 
 	/**
 	 * Get JP plugin data.
 	 *
-	 * @param mixed $plugin_file - JP or JP Dev plugin path.
+	 * @param string $plugin_file - JP or JP Dev plugin path.
 	 */
 	public static function get_jetpack_plugin_info( $plugin_file = null ) {
 
@@ -1418,7 +1420,7 @@ 
 	/**
 	 * Checks if a dir is empty.
 	 *
-	 * @param [type] $dir The absolute directory path to check.
+	 * @param string $dir The absolute directory path to check.
 	 * @return boolean
 	 */
 	public static function is_dir_empty( $dir ) {

projects/plugins/beta/class-jetpack-beta-admin.php

Doc Comments +1 added lines

@@ -729,6 +729,7 @@
 	 *
 	 * @param string $branch - Branch that's ready for update.
 	 * @param string $section - What kind of branch we're updated (master, rc, pr).
+	 * @return string
 	 */
 	public static function update_action_url( $branch, $section ) {
 		$query = array(

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

Doc Comments +1 added lines, -1 removed lines

@@ -229,7 +229,7 @@
  *
  * @param string $notify_moderator The value of the moderation_notify option OR if the comment is awaiting moderation.
  * @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/packages/autoloader/src/CustomAutoloaderPlugin.php

Doc Comments +1 added lines, -1 removed lines

@@ -168,7 +168,7 @@
 	/**
 	 * Checks to see whether or not the root package is the one that required the autoloader.
 	 *
-	 * @return bool
+	 * @return null|boolean
 	 */
 	private function isRequiredByRoot() {
 		$package  = $this->composer->getPackage();