docs: Hook interface doc comment review

Edited doc comments for hook interfaces to improve
consistency and add type hints.

Bug: T246855
Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2

2 files changed, 14 insertions, 9 deletions

diff --git a/includes/preferences/Hook/GetPreferencesHook.php b/includes/preferences/Hook/GetPreferencesHook.php
index acaaeacc2ec2..2615c9161eb0 100644
--- a/includes/preferences/Hook/GetPreferencesHook.php
+++ b/includes/preferences/Hook/GetPreferencesHook.php
@@ -2,18 +2,20 @@
 
 namespace MediaWiki\Preferences\Hook;
 
+use User;
+
 /**
  * @stable for implementation
  * @ingroup Hooks
  */
 interface GetPreferencesHook {
 	/**
-	 * Modify user preferences.
+	 * Use this hook to modify user preferences.
 	 *
 	 * @since 1.35
 	 *
-	 * @param ?mixed $user User whose preferences are being modified.
-	 * @param ?mixed &$preferences Preferences description array, to be fed to an HTMLForm object
+	 * @param User $user User whose preferences are being modified
+	 * @param array &$preferences Preferences description array, to be fed to an HTMLForm object
 	 * @return bool|void True or no return value to continue or false to abort
 	 */
 	public function onGetPreferences( $user, &$preferences );
diff --git a/includes/preferences/Hook/PreferencesFormPreSaveHook.php b/includes/preferences/Hook/PreferencesFormPreSaveHook.php
index 85d4aec56223..049d69c1c72f 100644
--- a/includes/preferences/Hook/PreferencesFormPreSaveHook.php
+++ b/includes/preferences/Hook/PreferencesFormPreSaveHook.php
@@ -2,21 +2,24 @@
 
 namespace MediaWiki\Preferences\Hook;
 
+use HTMLForm;
+use User;
+
 /**
  * @stable for implementation
  * @ingroup Hooks
  */
 interface PreferencesFormPreSaveHook {
 	/**
-	 * Override preferences being saved
+	 * Use this hook to override preferences being saved.
 	 *
 	 * @since 1.35
 	 *
-	 * @param ?mixed $formData array of user submitted data
-	 * @param ?mixed $form HTMLForm object, also a ContextSource
-	 * @param ?mixed $user User object with preferences to be saved set
-	 * @param ?mixed &$result boolean indicating success
-	 * @param ?mixed $oldUserOptions array with user old options (before save)
+	 * @param array $formData Array of user submitted data
+	 * @param HTMLForm $form HTMLForm object, also a ContextSource
+	 * @param User $user User with preferences to be saved
+	 * @param bool &$result Boolean indicating success
+	 * @param array $oldUserOptions Array with user's old options (before save)
 	 * @return bool|void True or no return value to continue or false to abort
 	 */
 	public function onPreferencesFormPreSave( $formData, $form, $user, &$result,