Automattic / jetpack

packages/options/legacy/class.jetpack-options.php

Doc Comments +11 added lines, -5 removed lines

@@ -18,7 +18,7 @@ 
 	 *
 	 * @param string $type The type of option to return. Defaults to 'compact'.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function get_option_names( $type = 'compact' ) {
 		switch ( $type ) {
@@ -187,7 +187,7 @@ 
 	 * This does _not_ adjust the prefix in any way (does not prefix jetpack_%)
 	 *
 	 * @param string $name Option name
-	 * @param mixed  $default (optional)
+	 * @param string  $default (optional)
 	 *
 	 * @return mixed
 	 */
@@ -211,6 +211,9 @@ 
 		return $value;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	private static function update_grouped_option( $group, $name, $value ) {
 		$options = get_option( self::$grouped_options[ $group ] );
 		if ( ! is_array( $options ) ) {
@@ -312,6 +315,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	private static function get_grouped_option( $group, $name, $default ) {
 		$options = get_option( self::$grouped_options[ $group ] );
 		if ( is_array( $options ) && isset( $options[ $name ] ) ) {
@@ -440,7 +446,7 @@ 
 	 * This function checks for a constant that, if present, will disable direct DB queries Jetpack uses to manage certain options and force Jetpack to always use Options API instead.
 	 * Options can be selectively managed via a blacklist by filtering option names via the jetpack_disabled_raw_option filter.
 	 *
-	 * @param $name Option name
+	 * @param string $name Option name
 	 *
 	 * @return bool
 	 */
@@ -466,7 +472,7 @@ 
 	 * @since 5.4.0
 	 *
 	 * @param boolean $strip_unsafe_options If true, and by default, will strip out options necessary for the connection to WordPress.com.
-	 * @return array An array of all options managed via the Jetpack_Options class.
+	 * @return string[] An array of all options managed via the Jetpack_Options class.
 	 */
 	static function get_all_jetpack_options( $strip_unsafe_options = true ) {
 		$jetpack_options            = self::get_option_names();
@@ -509,7 +515,7 @@ 
 	 *
 	 * @since 5.4.0
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	static function get_all_wp_options() {
 		// A manual build of the wp options

packages/tracking/src/lib/Client.php

Doc Comments +2 added lines, -1 removed lines

@@ -47,7 +47,7 @@ 
 
 	/**
 	 * record_event
-	 * @param  mixed  $event Event object to send to Tracks. An array will be cast to object. Required.
+	 * @param  Event  $event Event object to send to Tracks. An array will be cast to object. Required.
 	 *                       Properties are included directly in the pixel query string after light validation.
 	 * @return mixed         True on success, WP_Error on failure
 	 */
@@ -74,6 +74,7 @@ 
 
 	/**
 	 * Synchronously request the pixel
+	 * @param string $pixel
 	 */
 	static function record_pixel( $pixel ) {
 		// Add the Request Timestamp and URL terminator just before the HTTP request.

packages/tracking/src/Tracking.php

Doc Comments +4 added lines, -1 removed lines

@@ -143,6 +143,10 @@ 
 	 * @param int $user_id The user id of the local user
 	 * @return array $identity
 	 */
+
+	/**
+	 * @param Connection\Manager $connection_manager
+	 */
 	static function jetpack_tracks_get_identity( $user_id, $connection_manager ) {
 
 		// Meta is set, and user is still connected.  Use WPCOM ID
@@ -186,7 +190,6 @@ 
 	/**
 	 * Record an event in Tracks - this is the preferred way to record events from PHP.
 	 *
-	 * @param mixed  $identity username, user_id, or WP_user object
 	 * @param string $event_name The name of the event
 	 * @param array  $properties Custom properties to send with the event
 	 * @param int    $event_timestamp_millis The time in millis since 1970-01-01 00:00:00 when the event occurred