Automattic / jetpack

modules/theme-tools/compat/jitm-engine.php

Doc Comments +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 	/**
 	 * Add plan highlights to a list
 	 *
-	 * @param $list Message The list to apply to
+	 * @param Message $list Message The list to apply to
 	 * @param $cache Cache The jitm cache
 	 */
 	private static function add_plan_highlights_to_list( $list, $cache ) {

modules/theme-tools/compat/jitm-message.php

Doc Comments +20 added lines, -18 removed lines

@@ -794,7 +794,7 @@ 
 	 *
 	 * @param $external_user_id int The external user id
 	 *
-	 * @return object The rendered rule
+	 * @return \stdClass The rendered rule
 	 */
 	public function post_render( $external_user_id ) {
 		// render guides if there's at least one
@@ -849,7 +849,7 @@ 
 	/**
 	 * Requires a widget to be inactive
 	 *
-	 * @param $widget_slug string The slug of the widget
+	 * @param string $widget_slug string The slug of the widget
 	 *
 	 * @return $this
 	 */
@@ -862,7 +862,7 @@ 
 	/**
 	 * Requires the user or blog owner to be in the gdpr zone
 	 *
-	 * @param $flag bool Whether or not to show in the gdpr zone
+	 * @param boolean $flag bool Whether or not to show in the gdpr zone
 	 *
 	 * @return $this
 	 */
@@ -875,7 +875,7 @@ 
 	/**
 	 * Check if a blog has a specific sticker
 	 *
-	 * @param $sticker string The sticker to check for
+	 * @param string $sticker string The sticker to check for
 	 *
 	 * @return $this
 	 */
@@ -888,8 +888,8 @@ 
 	/**
 	 * Ensure that the browser carries a specific query string
 	 *
-	 * @param $key string The key to check for
-	 * @param $value string A regex to match
+	 * @param string $key string The key to check for
+	 * @param string $value string A regex to match
 	 *
 	 * @return $this
 	 */
@@ -899,6 +899,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param boolean $value
+	 */
 	public function with_backups_possible( $value ) {
 		$this->with_backups = $value;
 
@@ -943,7 +946,7 @@ 
 	/**
 	 * Ensure that a specific theme is active
 	 *
-	 * @param $theme
+	 * @param string $theme
 	 *
 	 * @return $this
 	 */
@@ -956,7 +959,7 @@ 
 	/**
 	 * Only show this JITM when the specified plugin is inactive OR not installed
 	 *
-	 * @param $plugin string The path to the plugin
+	 * @param string $plugin string The path to the plugin
 	 *
 	 * @return $this
 	 */
@@ -970,7 +973,7 @@ 
 	 * Only show this JITM when the specified plugin is active and installed
 	 * Multiple calls are treated as OR: if _any_ of the plugins are active, the rule passes
 	 *
-	 * @param $plugin string The path to the plugin
+	 * @param string $plugin string The path to the plugin
 	 *
 	 * @return $this
 	 */
@@ -983,7 +986,7 @@ 
 	/**
 	 * A rule for a plugin being installed but either active or not active
 	 *
-	 * @param $plugin string The path to the plugin
+	 * @param string $plugin string The path to the plugin
 	 *
 	 * @return $this
 	 */
@@ -996,7 +999,7 @@ 
 	/**
 	 * A rule to check that a specific plugin is not installed
 	 *
-	 * @param $plugin string The path to the plugin
+	 * @param string $plugin string The path to the plugin
 	 *
 	 * @return $this
 	 */
@@ -1009,7 +1012,7 @@ 
 	/**
 	 * Only show if the user is in the specified role
 	 *
-	 * @param $role string The role
+	 * @param string $role string The role
 	 *
 	 * @return $this
 	 */
@@ -1087,7 +1090,7 @@ 
 	 *
 	 * The hook to display the content on, such as `admin-notices`
 	 *
-	 * @param $regex string The message path regex
+	 * @param string $regex string The message path regex
 	 *
 	 * @return $this
 	 */
@@ -1130,7 +1133,7 @@ 
 	/**
 	 * Set's the priority of this specific jitm if there are any conflicts
 	 *
-	 * @param $priority int The priority. Higher numbers result in a higher priority
+	 * @param integer $priority int The priority. Higher numbers result in a higher priority
 	 *
 	 * @return $this
 	 */
@@ -1178,7 +1181,7 @@ 
 	/**
 	 * Set the maximum number of dismissals before this jitm will never be shown again
 	 *
-	 * @param $times int The maximum number of times to show this message
+	 * @param integer $times int The maximum number of times to show this message
 	 *
 	 * @return $this
 	 */
@@ -1244,7 +1247,6 @@ 
 	/**
 	 * Sets the ES query to check against the site profile
 	 *
-	 * @param bool $with_plan
 	 *
 	 * @return $this
 	 */
@@ -1303,7 +1305,7 @@ 
 	 * Limits the JITM to only the provided types.
 	 * Default: [ 'jetpack' ] (non-Atomic)
 	 *
-	 * @param array $site_types - can include 'jetpack', 'atomic'
+	 * @param string[] $site_types - can include 'jetpack', 'atomic'
 	 *
 	 * @return $this
 	 */
@@ -1342,7 +1344,7 @@ 
 	/**
 	 * A rule for a module to be activated
 	 *
-	 * @param $module string Module slug.
+	 * @param string $module string Module slug.
 	 *
 	 * @return $this
 	 */